Skip to content
IAP Workshop: Introduction to Markdown and MkDocs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
EDM.md
EDM.png
IAP2020-Mkdocs_slides.md
IAP2020-Mkdocs_slides.pdf
README.md

README.md

 

IAP-mkdocs-logo

IAP 2020: Introduction to Markdown and MkDocs


code style: prettier

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.

Prerequisites

  • Python 3 with pip installed
  • GitHub account

Workshop materials

Special thanks to...

Another project by...

👤 Wei Min Cher @flamanta

Please ⭐️ this repository if this project helped you!

You can’t perform that action at this time.