Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Convert to AsciiDoc #95
In light of #87 I think it'd be nice if we adopted a better format for the guide, namely AsciiDoc. It would allow us to have native admonitions, footnotes, sane nesting of list items, etc and to easily export the guide in various formats. That would also make it trivial to publish a simple site from the guide down the road if we want to.
It's trivial to convert to AsciiDoc with this tool https://github.com/asciidoctor/kramdown-asciidoc (created by the maintainer of AsciiDoctor himself).
In general my longer term plan is to convert all guides to AsciiDoc and maybe even RuboCop's own documentation.
You might find this article https://asciidoctor.org/docs/asciidoc-vs-markdown/ and the links at its bottom an interesting read.