Rendering of README.md inline with inner tree view dirs

Christian Hesse list at eworm.de
Mon Jun 11 09:53:43 CEST 2018


Andy Green <andy at warmcat.com> on Mon, 2018/06/11 15:38:
> On 06/11/2018 03:31 PM, Christian Hesse wrote:
> > Andy Green <andy at warmcat.com> on Mon, 2018/06/11 15:08:  
> >> Hi -
> >>
> >> I have been using cgit for many years.
> >>
> >> Currently I am detaching my (LGPL) project from github.
> >>
> >> One noticeable problem diverting people from github to cgit is although
> >> it renders very well the toplevel "about" README.md
> >>
> >> https://libwebsockets.org/git/libwebsockets/about/
> >>
> >> It doesn't seem to have a way to render inline inner dir README.md as
> >> github does.  This is quite a small thing but very useful, eg
> >>
> >> https://github.com/warmcat/libwebsockets/tree/master/minimal-examples
> >>
> >> vs
> >>
> >> https://libwebsockets.org/git/libwebsockets/tree/minimal-examples
> >>
> >> Is there a way to do it already in the main cgit project?  For nonpublic
> >> projects, I screenscraped some patches from John Keeping from 2016 that
> >> do the same thing, but poking around, these don't seem to have made it
> >> in.
> >>
> >> If there's no existing way to do it and those patches are shivering in
> >> the cold, all alone, can I suggest they would perhaps be extremely
> >> useful to people in a similar position, needing to decouple users from
> >> github but needing to generally present the same tree in a similar way?  
> > 
> > This is what you want?
> > 
> > https://libwebsockets.org/git/libwebsockets/about/minimal-examples/README.md  
> 
> Yeah.
> 
> But inline after the tree view, a la github.
> 
> This enables a scheme where inner dirs give their own overview without 
> interrupting navigation.  Eg, a couple of levels down...
> 
> https://github.com/warmcat/libwebsockets/tree/master/lib/roles

I think this is not possible with current code. What patches from John did
you apply?

BTW, linking withing formatted pages works, so this could be a step forward:

diff --git a/README.md b/README.md
index c6222b75..fee7dcae 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ News
 
 ## v3.0.0 released
 
-See the changelog for info https://libwebsockets.org/git/libwebsockets/tree/changelog?h=v3.0-stable
+See the [changelog](changelog?h=v3.0-stable) for info.
 
 ## Major CI improvements for QA
 
@@ -56,7 +56,7 @@ but the other browsers will catch up soon.
 
 ## New "minimal examples"
 
-https://libwebsockets.org/git/libwebsockets/tree/minimal-examples
+[minimal-examples](minimal-examples/README.md)
 
 These are like the test apps, but focus on doing one thing, the best way, with the minimum amount of code.  For example the minimal-http-server serves the cwd on http/1 or http/2 in 50 LOC.  Same thing with tls is just three more lines.

-- 
main(a){char*c=/*    Schoene Gruesse                         */"B?IJj;MEH"
"CX:;",b;for(a/*    Best regards             my address:    */=0;b=c[a++];)
putchar(b-1/(/*    Chris            cc -ox -xc - && ./x    */b/42*2-3)*42);}
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 488 bytes
Desc: OpenPGP digital signature
URL: <http://lists.zx2c4.com/pipermail/cgit/attachments/20180611/3308b72d/attachment-0001.asc>


More information about the CGit mailing list