Skip to content

Convert documentation in mkdocs format to a readable book in different formats (PDF/EPUB/HTML).

License

Notifications You must be signed in to change notification settings

ebadi/mkdocs2book

Repository files navigation

MKDOCS2BOOK

Convert documentation in mkdocs format to a readable book in different formats (PDF/EPUB/HTML).

How it works

1- Use modified version of mkdocscombine to combine all *.md files into a single pandoc (book.pd) file with the help of mkdocs.yml.

2- Use modified version of latex template file from pandoc-book-template

3- Use Pandoc to build the .PDF, .EPUB files

Example:


sudo rm *.pdf *.epub *.pd
sudo docker build -f Dockerfile -t mkdocs2book:latest .

git clone https://github.com/ebadi/carla.git
sudo docker run -v=$PWD:/data/ mkdocs2book:latest /data/build.sh carla

git clone https://github.com/ebadi/scenario_runner.git
sudo docker run -v=$PWD:/data/ mkdocs2book:latest /data/build.sh scenario_runner

Carla Simulator documentation in PDF format

Scenario Runner documentation in PDF format

(click on download on the next page)

About

Convert documentation in mkdocs format to a readable book in different formats (PDF/EPUB/HTML).

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published