Welcome to Mondrian IT Documents as Code¶

The objective of this site is to demonstrate and evaluate options to use Markdown to maintain concise, simpel to use and beautiful technical documentation. Markdown is a lightweight markup language that uses plain text with a simple, extensible formatting syntax. It is designed so that it can be converted to HTML and many other formats.

Markdown is the defacto standard for creating documents in DevOps in repositories such as GitHub and GitLab where the typical readme file is written in Markdown and the repository includes a generator that converts the text file in an HTML file.

This site is fully created in Markdown and is generated by the site generator Material for MkDocs. This site generator uses standard Markdown with Python MarkDown Extensions to create userfriendly, beautiful, static websites.

Markdown Cheatsheet¶

The Markdown Cheatsheet section includes a summary of often used MarkDown and is intended to serve as quick reference quide. For the full set of capabilities is referred to the documentation of Material for MkDocs, the MarkDown Guide and Python MarkDown Extensions.