12 KiB
Awesome Series @ Write Kit
Markdown (Syntax & Extensions, Documentation & Cheat Sheets, Libraries, ...) • Markdown Editors & (Pre)viewers • Books (Services, Hand-Written, Auto-Built w/ Open Data, ...)
Awesome Markdown
A collection of awesome markdown goodies (libraries, services, editors, tools, cheatsheets, etc.)
Note: :octocat: stands for the GitHub page and 💎 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.
Contributions welcome. Anything missing? Send in a pull request. Thanks.
Markdown
- Markdown (web: daringfireball.net/projects/markdown) - original Markdown syntax write-up and processor in Perl by John Gruber; no longer maintained (last update in Dec 2004)
- Talk - markdown-discuss mailing list
Documentation
Markdown Syntax Extensions
- SmartyPants - convert (c) into ?, "" into ?, etc.
- Emojis - :octocat:
- CriticMarkup - :octocat:
- GitHub Flavored Markup (GFM) - @mention, to do lists w/ [ ] and [x], etc.
MultiMarkdown (MMD)
- MultiMarkdown (MMD) - Markdown extensions by Fletcher Penney adding footnotes, tables, definition lists, document metadata (e.g. title, author, date, etc.) and more; first added to MultiMarkdown.pl
- Cheatsheet - syntax quick reference
- Test Suite :octocat:
- MultiMarkdown.pl :octocat: - historic MultiMarkdown.pl code; converter script in Perl (last update in Jan 2011)
Markdown Extra
- Markdown Extra - Markdown extensions by Michel Fortin; first added to PHP Markdown (Extra)
- Dingus - try Markdown Extra in your browser
Markdown Extended (MDE)
- Markdown Extended (MDE) @ aboutmde.org
- Spec
- Cheatsheet - syntax quick reference; examples side-by-side
- Dingus - try Markdown Extended in your browser
- Code :octocat: - converter script in PHP
Manuscripts
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 strucutre
- Manuscripts Book Starter Kit (github:
manuscripts/book-starter)
CommonMark
A strongly specified, highly compatible implementation of Markdown
CommonMark
(web: commonmark.org)
- Spec (web:
spec.commonmark.org) - Edited by John MacFarlane - Dingus (web:
spec.commonmark.org/dingus) - try CommonMark in your browser - Talk (web:
talk.commonmark.org) - Code (github:
jgm/CommonMark) - spec and reference code in JavaScript and C
GitHub Flavored Markdown (GFM)
CommonMark with GitHub Extensions
GitHub Flavored Markdown (GFM)
- Spec (web:
github.github.com/gfm) - Code (github:
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
Vanilla Flavored Markdown (VFMD)
A variant of Markdown with an unambiguous specification of its syntax
Vanilla Flavored Markdown (VFMD)
(web: vfmd.org, github: vfmd)
- Spec (web: vfmd.org/vfmd-spec/specification) - Edited by Roopesh Chander
- Code (github:
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
Markdown Documentation
Markdown Cheatsheets / Quick References
Markdown Getting Started Guides / Tutorials
Markdown Building Blocks
Markdown Libraries & Tools
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
- transform plain text input (strings or files) in various output formats (in PHP)
Babelmark
- Babelmark 2 - a tool for comparing the output of various implementations of Markdown syntax
- Babelmark 2 F.A.Q. - frequently asked questions (and answers) e.g. ... ??
Markdown Style Guides / Best Practices
to be done
Markdown Lint / Style Rule Checker
- mdlint to be done
Markdown Web Components / Custom Elements
<x-markdown>- to be done
Markdown to Website / Blog
Jekyll
(web: jekyllrb.com,
github: jekyll/jekyll,
gem: jekyll) -
transform your plain text into static websites and blogs (in Ruby)
Middleman
(web: middlemanapp.com,
github: middleman/middleman,
gem: [middleman]) -
makes developing websites simple (in Ruby)
Markdown to Email
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
Markdown to Presentation / Slideshow
Slide Show (S9)
(web: slideshow-s9.github.io,
github: slideshow-s9/slideshow,
gem: slideshow) -
a free web alternative to PowerPoint and Keynote in Ruby
- Templates (github:
slideshow-templates)
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.
Markdown to Portable Document Format (PDF)
- markdown-pdf :octocat:, (npm Package) - converts Markdown files to PDFs
Markdown Styles / Documents / Pages
The Zen of Page Designs
(github: pagedesigns)
Markdown to Books
The Zen of Book Designs
(github: bookdesigns)
Markdown to Table of Contents (TOC)
Generate a markdown table of contents (TOC) with remarkable
(github: markdown-toc)
Convert to Markdown Tools
Microsoft Word to Markdown
- word-to-markdowm gem :octocat:, 💎 - "liberate" content from the jail that is Microsoft Word documents; converts to plain-text Markdown
Hypertext Markup Language (HTML) to Markdown
Ruby
- reverse_markdown :octocat:, 💎 - map simple HTML back into markdown
- html2markdown :octocat:, 💎 - simple and flexible HTML to markdown converter
- hypertextmarkdown :octocat:, 💎 - HTML to markdown converter
- html2md :octocat:, 💎 - converts basic HTML to markdown
- unmarkdown :octocat:, 💎 - convert HTML to Markdown
- upmark :octocat:, 💎 - a HTML to Markdown converter
- remark :octocat: - HTML to Markdown converter in Ruby
JavaScript / Node.js
- to-markdown :octocat:, (npm Package) - a HTML to Markdown converter in JavaScript
- html2markdown :octocat:, (npm Package) - converting HTML to Markdown
- Markitdown - A client side web app that lets you paste formatted text from a webpage (e.g with links intact) and recieve markdown output.
- Markitdown.medusis.com :octocat: - A client side web app for converting rich text to markdown
Book Services
- Softcover.io - publish from the comfort of your command-line
- Softcover :octocat:, 💎 - a command line tool for book generation, building, and publishing
- GitBook.com - write and publish books with Markdown and Git
- GitBook :octocat: - a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc)
- Bitbooks.cc - Bitbooks turns a repo full of markdown files into a handsome, hosted, online book
- Franklin :octocat: - a static-site framework, optimized for online books
Articles
- Why You Shouldn't Use Markdown for Documentation by Eric Holscher, March 2016
- Why isn't there a formal grammar for Markdown? by Roopesh Chander, September 2014
Meta
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!