From mboxrd@z Thu Jan 1 00:00:00 1970 From: john at keeping.me.uk (John Keeping) Date: Mon, 18 Jun 2018 20:32:32 +0100 Subject: [PATCH v2 10/15] config: add global inline-readme list In-Reply-To: <152929068560.10419.9276417651833254121.stgit@mail.warmcat.com> References: <152928998685.10419.7869045561776063625.stgit@mail.warmcat.com> <152929068560.10419.9276417651833254121.stgit@mail.warmcat.com> Message-ID: <20180618193231.GT1922@john.keeping.me.uk> On Mon, Jun 18, 2018 at 10:58:05AM +0800, Andy Green wrote: > Allows the user to specify a list of filenames that should be > rendered inline with tree view, if present in the directory. > > Signed-off-by: Andy Green > --- > diff --git a/cgitrc.5.txt b/cgitrc.5.txt > index a1560eb..37858af 100644 > --- a/cgitrc.5.txt > +++ b/cgitrc.5.txt > @@ -250,6 +250,13 @@ index-info:: > is deprecated, and will not be supported by cgit-1.0 (use root-desc > instead). Default value: none. > > +inline-readme:: > + Append given filename to the list of filenames to be rendered after the > + tree navigation in tree view, if present in the directory being viewed. Eg, > + 'inline-readme=README.md'. You may also want a corresponding render. > + entry for the readme suffix, eg, > + 'render.md=/usr/libexec/cgit/filters/html-converters/md2html' The documentation in the following patch is a bit more descriptive than this. I wonder if it makes sense to follow the pattern we use for the "readme" option and say that this defines the default value for repo.inline-readme.