[PATCH v4 00/16] Render READMEs inline in tree view

Andy Green andy at warmcat.com
Sat Jun 23 13:10:10 CEST 2018



On 06/23/2018 07:04 PM, John Keeping wrote:
> On Wed, Jun 20, 2018 at 06:11:57PM +0800, Andy Green wrote:
>> The following series adds config to allow rendering of
>> selected READMEs inline after the tree view, where
>> present in the directory being viewed.
>>
>> Particularly you can use completely relative markdown to
>> inline pictures served from the current repo rev context,
>> eg,
>>
>> ![overview](./doc-assets/overview.png)
>>
>> will "just work" showing the png from the current view
>> rev context; this format also works in github.
>>
>> It builds on John Keeping's RENDER mode series from 2016.
>>
>> Typical config to enable it, if you have a README.md
>> looks like
>>
>> inline-readme=README.md
>> render.md=/usr/libexec/cgit/filters/html-converters/md2html
>>
>> You can see examples of it in operation at
>>
>> https://libwebsockets.org/git/libwebsockets/tree
>> https://libwebsockets.org/git/libwebsockets/tree/?h=v3.0-stable
>> https://warmcat.com/git/cgit/tree/
>>
>> The expected basis these apply on top of is
>>
>>   - jk/for-jason
>>   - ch/for-jason
>>
>> You can find these patches on top of the expected basis here
>>
>> https://warmcat.com/git/cgit/log/
>>
>> v4 collects all the reviewed by and implements yesterday's comments
> 
> Other than the left-over debugging line you've already pointed out
> yourself, this looks good to me.
> 
> I suggest you post a final version after the Git 2.18.0 update hits
> master and we can get this merged.

Great, will do.

-Andy



More information about the CGit mailing list