Re: Are limitations of the github asciidoctor renderer documented?

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Re: Are limitations of the github asciidoctor renderer documented?

mojavelinux
Administrator
Jon,

There's no dedicated page in the docs on this subject. We could certainly consider adding one in the new documentation site (currently in the process of being set up).

You can find numerous references to features and styling of AsciiDoc output on GitHub in the issue tracker, such as https://github.com/asciidoctor/asciidoctor/issues/976

The documentation should point out what I have often said, which is that we have little control over how AsciiDoc is rendered on GitHub and, at best, the rendering should be considered an adequate preview, not a publishing target. We're at the mercy of GitHub's decisions and commitments. They have decided to disable certain features (like the include directive), have denied the request to add integrations like Asciidoctor Diagram and STEM support, and have resisted changing styles to get things like text alignment and floats to work. We can't do anything about that (other than to continue to plead with them).

In contract, you'll find that GitLab has been willing to do all of these things. So it's certainly possible. But again, it's up to the maintainer of the platform.

Best Regards,

-Dan

On Wed, Nov 11, 2020 at 5:48 AM oddhack [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Github's built-in asciidoctor renderer seems to ignore :stem:, and I gather that it doesn't support include directives either, but despite considerable searching I haven't been able to find anything documenting just what all the restrictions are. It would be very helpful for our needs if there were a way to get latexmath or even just asciimath markup working via github, in case anyone has done this.

Jon



If you reply to this email, your message will be added to the discussion below:
https://discuss.asciidoctor.org/Are-limitations-of-the-github-asciidoctor-renderer-documented-tp8340.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML


--
Dan Allen (he, him, his) | @mojavelinux | https://twitter.com/mojavelinux