Awesome Series @ Write Kit
Markdown (Syntax & Extensions, Documentation & Cheat Sheets, Libraries, ...) • Markdown Editors & (Pre)viewers • Books (Services, Hand-Written, Auto-Built w/ Open Data, ...)
A collection of awesome markdown goodies (libraries, services, editors, tools, cheatsheets, etc.)
Note: :octocat: stands for the GitHub page and :gem: stands for the RubyGems page.
[ANNOUNCEMENT] Looking for the latest news, tools, tips & tricks, and more about markdown and friends? Follow along the Manuscripts News (@manuscriptsnews) channel on twitter for updates.
email-style writing for the web by John Gruber and Aaron Swartz
History / Genesis
Introducing Markdown by John Gruber - March 15, 2004
I've written a text-to-HTML formatting tool called Markdown, which is now available for download. Markdown allows web writers to compose text using a simple, readable, plain text formatting syntax; Markdown takes care of translating it to valid XHTML (or, if you prefer, HTML).
Dive into Markdown by John Gruber - March 19, 2004
You don't need to "preview" an email before you send it -- you write it, you read it, you edit it, right there.
In fact, I love writing email. Email is my favorite writing medium. I've sent over 16,000 emails in the last five years. The conventions of plain text email allow me to express myself clearly and precisely, without ever getting in my way.
Thus, Markdown. Email-style writing for the web.
Markdown by Aaron Swartz - March 22, 2004
For months I've been working with John Gruber on a new project. The idea was to make writing simple web pages, and especially weblog entries, as easy as writing an email, by allowing you to use much the same syntax and converting it automatically into HTML.
Together we pored over the syntax details from top to bottom, trying to develop the perfect format, and I think we've got something pretty darn great. We've tested it extensively: on our blogs, in my comments form, in our emails.
Documentation
Free book format for Markdown
Manuscripts
(web: manuscripts.github.io
,
github: manuscripts
) -
adds book.yml for book (meta) info e.g. title, author, publisher, year etc.
and contents.yml for table of contents and file structure
manuscripts/book-starter
)A strongly specified, highly compatible implementation of Markdown
CommonMark
(web: commonmark.org
)
spec.commonmark.org
) - Edited by John MacFarlane spec.commonmark.org/dingus
) - try CommonMark in your browsertalk.commonmark.org
)jgm/CommonMark
) - spec and reference code in JavaScript and CCommonMark with GitHub Extensions
GitHub Flavored Markdown (GFM)
github.github.com/gfm
)github/cmark
- reference code in C (fork of cmark w/ extensions)Extensions include:
Leaf Blocks: Tables ++ Container Blocks: Task list items ++ Inlines: Strikethrough; Autolinks; Disallowed Raw HTML
A variant of Markdown with an unambiguous specification of its syntax
Vanilla Flavored Markdown (VFMD)
(web: vfmd.org
, github: vfmd
)
vfmd/vfmd-src
) - reference code in C++Differences include:
Intra-word emphasis; Simplified reference link/image syntax; Lists and the 4-space rule; Better automatic link detection; Double blank lines as end of blocks; Starting number in lists; Misnested constructs; Including raw HTML; Character encoding
Pandoc
(web: pandoc.org
,
github: github.com/jgm/pandoc) -
a universal document converter (in Haskell)
kramdown
(web: kramdown.gettalong.org
,
github: gettalong/kramdown
,
gem: kramdown
) -
markdown library & command line tool (in Ruby)
Markdown Extended (MDE)
(github: e-picas/markdown-extended
marked
(web: marked.js.org
, github: marked :octocat:) a markdown parser and compiler. Built for speed. (In Javascript)
markdown-it
(web: markdown-it.github.io
, github: markdown-it :octocat:) Javascript markdown parser. 100% CommonMark support, extensions, syntax plugins & high speed.
Is extensible with plugins.
concat-md (npm, github) CLI and API to concatenate markdown files and modify as necessary. Also adds titles from FrontMatter, file names and directory names, decreases level of existing titles to comply with added titles.
mdcode (github: mdcode) Markdown code block authoring tool. It enables testable code blocks, with two-way synchronization between code blocks and source files.
to be done
<x-markdown>
]() - to be doneJekyll
(web: jekyllrb.com
,
github: jekyll/jekyll
:octocat:,
gem: jekyll
:gem:) -
transform your plain text into static websites and blogs (in Ruby)
Middleman
(web: middlemanapp.com
,
github: middleman/middleman
:octocat:,
gem: middleman
:gem:) -
makes developing websites simple (in Ruby)
Slate (github: lord/slate :octocat:) - beautiful API documentation, based on Middleman
Shins (github: Mermade/shins
:octocat:, npm: shins
) – beautiful API documentation, with node.js (port of Slate)
md-fileserver (github: md-fileserver :octocat:, npm: md-fileserver
) – View markdown files locally in browser.
Compiiile (github: @compiiile/compiiile :octocat:, npm: @compiiile/compiiile
) – Preview and serve folders containing Markdown files with full-text search and presentation slides.
Markdown Here
(web: markdown-here.com
,
github: adam-p/markdown-here
) -
a browser extension for rendering email written in Markdown;
available for Chrome, Firefox, Safari, Thunderbird, and more;
besides email also works with Evernote, Google Groups, Blogger, and more
Slide Show (S9)
(web: slideshow-s9.github.io
,
github: slideshow-s9/slideshow
,
gem: slideshow
) -
a free web alternative to PowerPoint and Keynote in Ruby
slideshow-templates
)Slidev (github: slidev
) - Slidev allows you to create slideshows from a markdown file. You can include HTML and Vue components in the markdown.
Markpress (github: markpress
) - A command line tool and node package to convert markdown files into self-contained impressjs html presentations. Example
nodePPT (github: nodePPT
) - A web presentation tool supporting markdown based on GFM.
Deckset (website: Deckset) – A macOS desktop app that renders Markdown presentations in beautifully designed templates.
GitPitch (website: GitPitch, github: gitpitch :octocat:) – Markdown Presentations For Everyone on GitHub, GitLab, Bitbucket, GitBucket, Gitea, and Gogs. Example
zoetic (github zoetic) - Markdown presentations with your webcam as your background while presenting
The Zen of Page Designs
(github: pagedesigns
)
The Zen of Book Designs
(github: bookdesigns
)
Hyper Book (H9) :octocat:, :gem:
markdown-toc
) Ruby
JavaScript / Node.js
to-markdown
)More
Generate API documentation from source code in Markdown, then host it on the web using one of the many Markdown to Website tools to host and serve it.
JavaScript / Node.js
License
The awesome list is dedicated to the public domain. Use it as you please with no restrictions whatsoever.
Questions? Comments?
Send them along to the markdown-discuss mailing list. Thanks!