Markdown¶
Markdown is a simple and easy-to-read language for formatting plain text.
It is widely used to write documentation and research papers (eg see R Markdown), GitHub uses it as the default for README files, and many websites are written in Markdown (before being automatically converted to HTML).
The geogeeks website is written in Markdown, see the source of this page!
Getting started¶
Markdown: basic + extended versions¶
The original Markdown is rather limited, but it has been extended by several to add more complex features (like tables, code-blocks, or admonitions).
Watch out, it's a bit the far-west out there: some processors might not be able to parse your flavour of Markdown correctly!?
GitHub Flavoured Markdown
GitHub offers an useful overview of the features they added for their extended version called "GitHub Flavoured Markdown (GFM)".
Software to process Markdown¶
- PyCharm/CLion will preview automatically any Markdown files
- any file
.md
pushed to GitHub will be rendered automatically - dillinger.io: a handy web-preview tool
- Exhaustive list of processors