IAP 2020: Introduction to Markdown and MkDocs

Why? start with why

Markdown is a lightweight markup language that:

  • is very easy to pick up;
  • can be converted into many file formats such as PDF, DOCX, EPUB, HTML, etc. using Pandoc;
  • can generate diagrams such as UML Sequence Diagrams, Flowcharts, Class and State Diagrams;
  • can be used to create a static site, using the static generator MkDocs.


  • Python 3 with pip installed
  • GitHub account

Workshop materials

Special thanks to...

Another project by...

👤 Wei Min Cher @flamanta

Please ⭐️ this repository on GitHub if this project helped you!