Markdown: General¶
Overview¶
General cookbook for Markdown
Code¶
Using mkdocs with Materials themes¶
I use mkdocs engine with Material theme
Using basic extensions from material support¶
Material has been designed multiple features/references that help the most use-cases in my document space.
The following list has been used:
| References | Description |
|---|---|
| Admonition | Collapsible and to nest arbitrary content inside admonitions |
| Annotation | All inline- and block-level elements |
| Icons, Emojis | Icon by shortcodes in Material Design, FontAwesome, Octicons, Simple Icons |
| Diagrams | // |
| Images | // |
| Math | // |
| Footnotes | // |
| Tooltips | // |
For detail: https://squidfunk.github.io/mkdocs-material/reference
For list of icon, go through: https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
Plugin: mkdocs-table-reader-plugin to render table file format (csv, xlsx)¶
There are readers available for many common table formats, like .csv, .fwf, .json, .xls, .xlsx, .yaml, .feather and .tsv. There is also the read_raw() reader that will allow you to insert tables (or other content) already in markdown format.
See: https://timvink.github.io/mkdocs-table-reader-plugin/
Random character¶
See: https://en.wikipedia.org/wiki/Block_Elements#Character_table