awesome-markdown/README.md

awesome-markdown

A collection of awesome markdown goodies, libraries, services, tools, guides, books, etc.

Note: :octocat: stands for the GitHub page and 💎 stands for the RubyGems page.

---

---

Contributions welcome. Anything missing? Send in a pull request. Thanks.

Markdown

• 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 @ Wikipedia

Markdown Syntax Extensions

• MultiMarkdown (MMD) - Markdown extensions by Fletcher Penney adding footnotes, tables, definition lists, document metadata (e.g. title, author, date, etc.) and more
• SmartyPants - convert (c) into ?, "" into ?, etc.
• Emojis - :octocat:
• CriticMarkup - :octocat:
• GitHub Flavored Markup (GFM) - @mention, to do lists w/ [ ] and [x], etc.

CommonMark

A strongly specified, highly compatible implementation of Markdown

• commonmark.org
• Spec
• Code :octocat: - spec and reference code in JavaScript and C
• Dingus - try CommonMark (live) in your browser
• Talk

Markdown Documentation

Markdown Cheatsheets / Quick References

• Markdown Cheatsheet :octocat:

Markdown Getting Started Guides / Tutorials

• Markdown Tutorial - :octocat:
• Mastering Markdown @ GitHub Guides
• Markdown Basics @ GitHub Help

Markdown Building Blocks

Markdown Libraries

• kramdown - :octocat:, 💎 - markdown library (in Ruby)

Test

• Babel2 - to be done
  • [Babel2 F.A.Q.] - frequently asked questions (and answers) e.g. ... ??

Markdown Web Components / Custom Elements

• <x-markdown> - to be done

Markdown Editors

Zen Writing - leaving you alone with your thoughts and your words

Markdown Online Editors

• Minimalist Online Markdown Editor - :octocat:
• StackEdit - :octocat:
• Markdown Note - :octocat: - another simple single HTML page, server-less Markdown editor in JavaScript

Markdown Desktop Editors

Universal

• Atom + Markdown Preview - to be done

Windows

• WriteMonkey - full screen distraction free creative writing; no whistles and bells, just empty screen, you and your words; WriteMonkey is light, fast, and free

Markdown Command Line Tools

• Pandoc - :octocat: - a universal document converter (in Haskell)
• Jekyll - :octocat:, 💎 - transform your plain text into static websites and blogs (in Ruby)
• Middleman - :octocat:, 💎 - makes developing websites simple (in Ruby)

Markdown to Website / Blog

Markdown to Email

• Markdown Here - :octocat: - 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) - :octocat:, 💎 - a free web alternative to PowerPoint and Keynote in Ruby
  • Templates :octocat:

Markdown to Portable Document Format (PDF)

• markdown-pdf :octocat:, (npm Package) - converts Markdown files to PDFs

Markdown to Books

• Hyper Book (H9) :octocat:, 💎
  • Templates :octocat:

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

Command Line Examples

Pandoc

$ pandoc file.html -o file.md

kramdown

$ kramdown --input html --output kramdown file.html > file.md

Real World "Hand-Written" Book Examples

• Open Data Handbook, 2nd Edition - :octocat: - note: 1st edition in reStructedText, 2nd edtion in markdown
• Pro Git, 2nd Edition - :octocat: - note: 1st edition in markdown, 2nd edition in asciidoc
• PHP - The Right Way - :octocat:
• The Front-End Tooling Book - :octocat:
• Go Bootcamp - :octocat:

Open Data "Auto-Build" Book Examples

• Free World Beer Book - :octocat: - work-in-progress; auto-build using the beer.db and markdown templates w/ a static site generator
  • Templates :octocat:

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

Alternatives

More lightweight markup languages

• Wikitext, Wikicode - wiki markup used by Wikipedia and friends
  • Creole - "Standardized" core Wikitext markup
• AsciiDoc
• Textile
• reStructuredText (rst, reST)
• BBCode - bulletin board code

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!