librecores / librecores-pipeline-lib

Jenkins Pipeline library for LibreCores CI
MIT License
8 stars 6 forks source link

Convert README to Asciidoc, enable TOC #12

Open oleg-nenashev opened 4 years ago

oleg-nenashev commented 4 years ago

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 commented 4 years ago

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

rdmueller commented 4 years ago

@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 commented 4 years ago

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