Asciidoctor compatibility for part of readme #640
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our README.asciidoc file has source listing containing asciidoc code which is rare for our books. Asciidoctor was rendering it incorrectly because of its "automatic comment detection" that it uses with callouts. It saw ``` -- <1> ``` And through "that is a SQL comment preceeding a callout so I will eat the `--`". While *normally* helpful, this is wrong when commenting on asciidoc source. I work around this by writing ``` pass:[--] <1> ``` Which spits out the desired `--` followed by a callout. To get that working I had to poke the language declaration line some, especially because AsciiDoc doesn't support the simpler Asciidoctor syntax for enabling macros inside of listings. This another thing that our `html_diff` based integration tests caught.
ddillinger
approved these changes
Feb 25, 2019
|
Thanks for reviewing @ddillinger! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our README.asciidoc file has source listing containing asciidoc code
which is rare for our books. Asciidoctor was rendering it incorrectly
because of its "automatic comment detection" that it uses with callouts.
It saw
And through "that is a SQL comment preceeding a callout so I will eat
the
--". While normally helpful, this is wrong when commenting onasciidoc source. I work around this by writing
Which spits out the desired
--followed by a callout. To get thatworking I had to poke the language declaration line some, especially
because AsciiDoc doesn't support the simpler Asciidoctor syntax for
enabling macros inside of listings.
This another thing that our
html_diffbased integration tests caught.