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

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

From
Scott Chacon <schacon@gmail.com>
Date
Sep 9, 2011, 15:45 UTC
Message-ID
<CAP2yMaJ+UBHZp0U=QWOZbnbbOuq8vNoJODWtxZPb1sKXTC_UEg@mail.gmail.com>
In-Reply-To
<4E6A23DB.1040606@drmicha.warpmail.net>
Hey,

On Fri, Sep 9, 2011 at 7:34 AM, Michael J Gruber <git@drmicha.warpmail.net> wrote:

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

I can change this so we can render .asc if that's less ugly. I've been meaning to do this for a while, but I don't think I ever incorporated it.

Show 11 quoted lines
>
> 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

If this is interesting to people, I can help out. However, you can also fix rendering issues, as long as they don't introduce security issues (which 'include' and macros can do) by fixing it here:

https://github.com/github/markup

That is the rendering engine we use. If you make it work how you want and it's safe and you send us a pull request, we'll happily take fixes to the asciidoc renderer.

Scott
Previous: Michael J GruberNext: Michael Haggerty
Message 2 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.