Skip to content

Markdown

Markdown is a human readable plain text format for creating HTML content.

A markdown file with a .md extension can be converted to a .html file which can be rendered / viewed in a web browser. A lot of online web tools like forums, blogs, static site generators and other websites like GitHub have support for Markdown.

A block of markdown can be converted to a block of HTML. For example:

# Title
### Sub title

gets converted to:

<h1>Title</h1>
<h3>Sub title</h3>

mkdocs

mkdocs the documentation generator used for this project also uses Markdown for its content. So, we can write notes in markdown and mkdocs will convert that note into structured HTML pages that can be read on a browser.

Cheat sheet

A frequently used list of markdown elements

Element Markdown Syntax
Heading # H1
## H2
### H3
Bold __bold text__
**bold text**
Italic _italicized text_
*italicized text*
Blockquote > blockquote
Ordered List 
 1. First item 
 2. Second item 
 3. Third item
Unordered List 
 - First item 
 - Second item 
 - Third item
Code 'code'
Horizontal Rule ---
Link [Google](https://www.google.com)
Table 
 | Syntax | Description |
 | ------ | ----------- |
 | Header | Title |
 | Paragraph | Text |
Task List 
 - [x] Write code 
 - [ ] Update the website 
 - [ ] Contact the manager

References