Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.27 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.27 KB
Raw

adoc2md

What is this project for?

I want to author documents of my own programming project in the Asciidoc format, and publish them on GitHub Pages in the GitHub Flavored Markdown format (a.k.a. GFM). Also, I want to add a table of contents to my documents written in GFM.

The above phrase looks simple. But actually it involves several technical issues to resolve. In this project, I will present a resolution for me.

What this project provides?

This is a small shell script (bash) tested on macOS that does the following:

  1. the script transforms a file <projectDir>/docs/index_.adoc written in Asciidoc format into a file docs/index.md in GitHub Flavored Markdown format. To implement this, Asciidoctor and Pandoc are used.
  2. the script modifies the output index.md file so that it can add a table of contents utilizing the Jekyll Blog's feature.

How to use it

$ cd adoc2md
$ ./gendocs.sh

or

$ cd adoc2md
$ gradle gendocs

Sample documentation written in Asciidoc with TOC

See https://kazurayam.github.io/adoc2md/