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 README to Asciidoc, enable TOC #12

Open
oleg-nenashev opened this issue Sep 28, 2019 · 3 comments · May be fixed by #15
Open

Convert README to Asciidoc, enable TOC #12

oleg-nenashev opened this issue Sep 28, 2019 · 3 comments · May be fixed by #15

Comments

@oleg-nenashev
Copy link
Member

Currently the README is written in Markdown, and GitHub does not support automatic table of contents for it. We should rather convert the docs to Asciidoc and add proper macros

@MeatyFresh
Copy link

I'd like to tackle this. Not used Asciidoc before, good opportunity to learn about it.

@rdmueller
Copy link

@MeatyFresh If you use intellij and you have the asciidoc plugin installed, there will be a "convert to asciidoc" on the context / right click menu.

give it a try!

@MeatyFresh
Copy link

@rdmueller I was going to build the file manually, but I'll give IntelliJ a whirl. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants