Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert to AsciiDoc #95

Closed
bbatsov opened this issue Apr 30, 2019 · 4 comments

Comments

@bbatsov
Copy link
Contributor

commented Apr 30, 2019

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.

@bbatsov

This comment has been minimized.

Copy link
Contributor Author

commented Apr 30, 2019

You might find this article https://asciidoctor.org/docs/asciidoc-vs-markdown/ and the links at its bottom an interesting read.

@pirj

This comment has been minimized.

Copy link
Member

commented Apr 30, 2019

Agree, I have very positive experience with AsciiDoc. And this guide is a good starting point.

@bbatsov

This comment has been minimized.

Copy link
Contributor Author

commented May 2, 2019

Great! Would you tackle the conversation yourself?

@pirj

This comment has been minimized.

Copy link
Member

commented May 2, 2019

Yes, definitely.

pirj added a commit that referenced this issue May 2, 2019

Convert to AsciiDoc
AsciiDoc allows for admonitions, footnotes, sane nesting of list items,
and easily export in various formats.

Fixes #95

@pirj pirj referenced this issue May 2, 2019

Merged

Convert to AsciiDoc #97

pirj added a commit that referenced this issue May 7, 2019

Convert to AsciiDoc
AsciiDoc allows for admonitions, footnotes, sane nesting of list items,
and easily export in various formats.

Fixes #95

@pirj pirj closed this in #97 May 7, 2019

@pirj pirj self-assigned this May 7, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.