xonixx/mdbooker

Convert your README.md into a documentation site (via mdBook)

mdbooker

Converts your README.md into a documentation site (via mdBook).

It works by splitting README.md file into multiple .md documents based on title. It also generates the SUMMARY.md.

Article: mdbooker – turn your README.md into a documentation site

Demo

README.md ➡ makesure.dev

Usage

REPO=username/reponame [BOOK=book_folder_path] awk -f mdbooker.awk README.md

then

mdbook build