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

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

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Sep 9, 2011, 14:34 UTC
Message-ID
<4E6A23DB.1040606@drmicha.warpmail.net>
Hi there,

I've been looking more to GitHub lately and was wondering whether it is worth to leverage their automatic asciidoc rendering for our asciidoc files. I have put up a test tree at

https://github.com/gitigit/git/tree/githubtest

which has all the renaming (*.txt -> *.asciidoc) and Makefile and script changes, but is missing some include changes (because include breaks anyway, see below).

The simple renaming already gives a rendered display of blobs for simpler asciidoc files like release notes

https://github.com/gitigit/git/blob/githubtest/Documentation/RelNotes/1.7.7.asciidoc
and api documentation
https://github.com/gitigit/git/blob/githubtest/Documentation/technical/api-credentials.asciidoc
For the man pages, there are several problems as can be seen here:
https://github.com/gitigit/git/blob/githubtest/Documentation/git-blame.asciidoc

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
Michael
Next: Scott Chacon
Message 1 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.