git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: RFD: leveraging GitHub's asciidoc rendering for our Documentation/

From
Jeff King <peff@peff.net>
Date
Sep 9, 2011, 19:05 UTC
Message-ID
<20110909190547.GF28480@sigill.intra.peff.net>
In-Reply-To
<7v4o0lvcq3.fsf@alter.siamese.dyndns.org>
On Fri, Sep 09, 2011 at 10:37:24AM -0700, Junio C Hamano wrote:
Show 15 quoted lines
> Michael J Gruber <git@drmicha.warpmail.net> writes:
> 
> > Our own customisation is not loaded (of course) so that, e.g., the
> > linkgit macro does not work; and the include statement makes GitHub's
> > parser unhappy and choke.
> >
> > Does anybody feel this is worth pursuing?
> >
> > + Nicer blob view
> > + Simpler way to judge documentation changes
> > - Need to get our asciidoc config in there
> > - GitHub's parser neeeds to learn include
> 
> Personally I am not very interested. Couldn't you just visit the html
> branch instead for viewing?

I agree that it's not very nice for release-quality documentation. But if I understand correctly, Michael means that you can go straight to any blob at any commit of any fork on github, and get the rendered (or raw) version. Which is neat.

How frequently do you build the html branch? I always assumed it was once in a while (every push?), not for every commit.

We could help that along by giving our documentation a more descriptive filename. But it would be cool if GitHub respected gitattributes for this, too.

-Peff
Previous: Michael J GruberNext: Junio C Hamano
Message 8 of 10 in “RFD: leveraging GitHub's asciidoc rendering for our Documentation/”
  1. Michael J GruberSep 9, 2011
  2. Scott ChaconSep 9, 2011
  3. Michael HaggertySep 9, 2011
  4. Michael J GruberSep 9, 2011
  5. Giuseppe BilottaSep 10, 2011
  6. Junio C HamanoSep 9, 2011
  7. Michael J GruberSep 9, 2011
  8. Jeff KingSep 9, 2011
  9. Junio C HamanoSep 9, 2011
  10. Fwd: RFD: leveraging GitHub's asciidoc rendering for our Documentation/Sitaram Chamarty, Sep 9, 2011

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.