The markdown-guide project is a collection of reviews, tutorials, documents, and scripts relating to markdown — in all its different flavors — and the existing tools to work with it.
This is the Moreh Nevukhim (מורה נבוכים) of all markdown seekers.
This project is maintained by Tristano Ajmone (aka T.Ajmonides), it was created in December 2016, and its title is a witty homage to the great Rambam.
The markdown-guide project is unrestrictedly free to use: it is released into the public domain under Unlicense terms.
Documents on markdown history, its motives, how it evolved, etc.
- https://daringfireball.net/projects/markdown/ – John Gruber’s website: where it all started…
- Wikipedia entry for markdown
There are numerous markdown syntax variants, better known as «markdown flavors» or «dialects», each one differing from the Gruber’s original Markdown implementation in the way syntax rules are implemented and (usually) by introducing new features.
(WIP – Work In Progress)
GitHub Flavored Markdown (GFM) is the Markdown dialect used by GitHub to visualize user content on GitHub.com and GitHub Enterprise. It’s a very popular Markdown flavor, bringing to markdown some nice extra features – task-lists, emoji, keystrokes, and others.
On March 14th, 2017 GitHub announced its official formal specification for GFM, based on the CommonMark Spec:
The /editors/ folder is dedicated to Markdown editing and editors:
Command line tools to perform operations on markdown source files – such as conversion to and from other formats, source tidying up, auto-generation of TOC, etc.
Pandoc is such a key tool in the world of markdown that it deserves a folder of its own within this repo:
/pandoc/– pandoc related markdown resources./pp/— PP, A Generic Preprocessor with Pandoc in mind.
A first temptative list of markdown parsers:
| NAME | MD FLAVORS | EXTENSIBLE | LANGUAGE |
|---|---|---|---|
| markdown-it | CommonMark | YES | JavaScript |
| marked | all MD + GFM | JavaScript |
NOTE: Parsers are not being added in a systematic way right now. I’m just adding to the list those parser which, for one reason or another, I’m stumbling across during links-chasing. I do have a long list of parsers to add in my shopping list, and will eventually get around to properly fill this table.
Markdown for Bloggers:
- Introduction
- Basic Formatting
- Headlines & Lists
- Web Links
- Quoting Text and Code
- The Monster List of Markdown Tools (2015)
“Only awesome is awesome”
– The awesome manifesto
- Awesome Markdown Editors & (Pre)viewers (@mundimark) – A collection of awesome markdown editors & (pre)viewers for Linux, Apple OS X, Microsoft Windows, the World Wide Web & more.
- Awesome Markdown (@BubuAnabelas) – A curated list of delightful Markdown stuff.
- Awesome Markdown (@mashk) – A curated list of awesome Markdown tools.
- Awesome Markdown (@mundimark) – A collection of awesome markdown goodies (libraries, services, editors, tools, cheatsheets, etc.)
- Markdown Resources (@rhythmus) – A curated collection of Markdown resources: apps, dialects, parsers, people, …
- Awesome kramdown (@viennahtml) – A collection of awesome kramdown goodies for the markdown converter made with ♥ in Vienna ;-)
- Awesome Markdown Alternatives (@mundimark)