Pandoc Markdown and Publishing - overlord-supreme/checkers GitHub Wiki
pandoc *.md -o result.pdf
pandoc -s -o doc.html part01.md part02.md
- download pandoc
- write up files in markdown
- convert to
rtf
(rich text format)
- export to
pdf
(portable document format)
pandoc test.md --bibliography testlibrary.bib --smart --normalize -s -o success.rtf
- note, this is not Github-flavored Markdown, which you may be more familiar with
- might be interesting to mess with
- adds a bunch of features, styles nicely
- many FOSS projects use this
pip install mkdocs # installs mkdocs
mkdocs new docs # creates new project
# `$pwd = docs`
py -m mkdocs build --clean # builds the documentation (`md` -> `html`)
py -m mkdocs serve # serves it on port `8080`
- way of styling and exporting the above
pandoc *.md > book.html
PR
-> Unit Test
-> Docs Update
- treat doc-bugs like code-bugs
- include docs in code-review
- make part of ci/cd
- tie versioning to git
- mkdocs
- yaml config
- markdown text
- themes
- python, jinja2
- extensions
- current setup (2019)