Difference between revisions of "Markdown"

From Things and Stuff Wiki
Jump to navigation Jump to search
Line 5: Line 5:
  
  
* [http://daringfireball.net/projects/markdown/ Markdown] is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
+
* [http://daringfireball.net/projects/markdown/ Markdown] - a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).
 
** http://daringfireball.net/projects/markdown/syntax
 
** http://daringfireball.net/projects/markdown/syntax
 
** https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
 
** https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
Line 12: Line 12:
 
* https://github.com/rhythmus/markdown-resources - A curated collection of Markdown resources: apps, dialects, parsers, people, …
 
* https://github.com/rhythmus/markdown-resources - A curated collection of Markdown resources: apps, dialects, parsers, people, …
  
 +
* https://w3.org/community/markdown
  
 
=== Variations ===
 
=== Variations ===
 +
 +
* https://w3.org/community/markdown/wiki/MarkdownImplementations
 +
 +
 
* [http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html The Future of Markdown] - 25 Oct 2012 [http://news.ycombinator.com/item?id=4700160]
 
* [http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html The Future of Markdown] - 25 Oct 2012 [http://news.ycombinator.com/item?id=4700160]
  
Line 23: Line 28:
 
* https://tools.ietf.org/html/rfc7764 - Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations [https://news.ycombinator.com/item?id=13176743]
 
* https://tools.ietf.org/html/rfc7764 - Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations [https://news.ycombinator.com/item?id=13176743]
  
 +
 +
* http://blogs.plos.org/mfenner/2012/12/13/a-call-for-scholarly-markdown/
 +
* http://indiewebcamp.com/2013/Citations_and_Scholarly_Markdown
 +
 +
 +
* http://arstechnica.com/information-technology/2014/10/markdown-throwdown-what-happens-when-foss-software-gets-corporate-backing/
 +
* [http://www.wilfred.me.uk/blog/2012/07/30/why-markdown-is-not-my-favourite-language/ Why Markdown Is Not My Favourite Language] - 30 July 2012 - recommends Creole [https://news.ycombinator.com/item?id=5613841]
  
 
==== CommonMark ====
 
==== CommonMark ====
Line 38: Line 50:
 
==== R Markdown ====
 
==== R Markdown ====
 
* [https://bookdown.org/yihui/rmarkdown/ R Markdown: The Definitive Guide]
 
* [https://bookdown.org/yihui/rmarkdown/ R Markdown: The Definitive Guide]
 +
 +
====  Markdown Extra ====
 +
* [http://michelf.ca/projects/php-markdown/extra/ Markdown Extra] - an extension to PHP Markdown implementing some features currently not available with the plain Markdown syntax. Markdown Extra is available as a separate parser class in PHP Markdown Lib.
  
 
==== Markdown Extended ====
 
==== Markdown Extended ====
Line 47: Line 62:
  
 
== Tools ==
 
== Tools ==
 +
* [http://jaspervdj.be/lorem-markdownum/ Lorem Markdownum] - Inspired by the many excellent lorem ipsum generators, this simple webapp generates placeholder text. However, instead of generating plain text, this generator gives you structured text in the form of markdown. In order to do so, it uses Markov Chains and many heuristics.
 +
** https://github.com/jaspervdj/lorem-markdownum
  
 
=== Browser ===
 
=== Browser ===
 
* [http://markdown-here.com/ Markdown Here] - a Google Chrome, Firefox, Safari, Opera, and Thunderbird extension that lets you write email in Markdown and render them before sending. It also supports syntax highlighting (just specify the language in a fenced code block).
 
* [http://markdown-here.com/ Markdown Here] - a Google Chrome, Firefox, Safari, Opera, and Thunderbird extension that lets you write email in Markdown and render them before sending. It also supports syntax highlighting (just specify the language in a fenced code block).
 
** https://github.com/adam-p/markdown-here
 
** https://github.com/adam-p/markdown-here
 
=== Templates ===
 
* https://github.com/mwhite/resume - a simple Markdown resumé template, LaTeX header, and pre-processing script that can be used with Pandoc to generate professional-looking PDF and HTML output.
 
 
 
 
* [https://www.mkdocs.org/ MkDocs] - a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
 
 
 
* https://github.com/axiros/terminal_markdown_viewer - Python based Markdown viewer for the terminal might be a good option.
 
  
  
 +
=== CSS / JS ===
 
* [http://mrcoles.com/demo/markdown-css/ Markdown.css] - CSS to make HTML markup look like plain-text markdown.
 
* [http://mrcoles.com/demo/markdown-css/ Markdown.css] - CSS to make HTML markup look like plain-text markdown.
  
  
 
* [https://code.google.com/p/pagedown/ PageDown] - the JavaScript Markdown previewer used on Stack Overflow and the rest of the Stack Exchange network. It includes a Markdown-to-HTML converter and an in-page Markdown editor with live preview.
 
* [https://code.google.com/p/pagedown/ PageDown] - the JavaScript Markdown previewer used on Stack Overflow and the rest of the Stack Exchange network. It includes a Markdown-to-HTML converter and an in-page Markdown editor with live preview.
 
 
* http://blogs.plos.org/mfenner/2012/12/13/a-call-for-scholarly-markdown/
 
* http://indiewebcamp.com/2013/Citations_and_Scholarly_Markdown
 
 
 
* http://www.w3.org/community/markdown
 
** http://www.w3.org/community/markdown/wiki/MarkdownImplementations
 
 
 
 
* [http://jaspervdj.be/lorem-markdownum/ Lorem Markdownum] - Inspired by the many excellent lorem ipsum generators, this simple webapp generates placeholder text. However, instead of generating plain text, this generator gives you structured text in the form of markdown. In order to do so, it uses Markov Chains and many heuristics.
 
** https://github.com/jaspervdj/lorem-markdownum
 
 
* [http://michelf.ca/projects/php-markdown/extra/ Markdown Extra] is an extension to PHP Markdown implementing some features currently not available with the plain Markdown syntax. Markdown Extra is available as a separate parser class in PHP Markdown Lib.
 
 
 
* https://github.com/visit1985/mdp - A command-line based markdown presentation tool. [https://news.ycombinator.com/item?id=8340731]
 
 
 
* http://arstechnica.com/information-technology/2014/10/markdown-throwdown-what-happens-when-foss-software-gets-corporate-backing/
 
 
 
  
  
Line 99: Line 84:
 
* [http://casual-effects.com/markdeep/ Markdeep] - a technology for writing plain text documents that will look good in any web browser. It supports diagrams, common styling conventions, and equations as extensions of Markdown syntax. [https://news.ycombinator.com/item?id=10402121]
 
* [http://casual-effects.com/markdeep/ Markdeep] - a technology for writing plain text documents that will look good in any web browser. It supports diagrams, common styling conventions, and equations as extensions of Markdown syntax. [https://news.ycombinator.com/item?id=10402121]
 
** https://github.com/reelsense/markdeep
 
** https://github.com/reelsense/markdeep
 
 
 
 
 
 
* [http://www.wilfred.me.uk/blog/2012/07/30/why-markdown-is-not-my-favourite-language/ Why Markdown Is Not My Favourite Language] - 30 July 2012 - recommends Creole [https://news.ycombinator.com/item?id=5613841]
 
  
  
 
* [http://showdownjs.com/ Showdownjs] - A Markdown to HTML bidirectional converter written in Javascript!
 
* [http://showdownjs.com/ Showdownjs] - A Markdown to HTML bidirectional converter written in Javascript!
 
** https://github.com/showdownjs/showdown
 
** https://github.com/showdownjs/showdown
 +
  
 
== Table of Contents ==
 
== Table of Contents ==
 
* http://doctoc.herokuapp.com/ - generate ToC
 
* http://doctoc.herokuapp.com/ - generate ToC
 +
  
 
* https://github.com/ekalinin/github-markdown-toc
 
* https://github.com/ekalinin/github-markdown-toc
Line 123: Line 103:
 
         * [OR using Vundle:](#or-using-vundle)
 
         * [OR using Vundle:](#or-using-vundle)
 
   * [License](#license)
 
   * [License](#license)
 +
  
 
* https://github.com/thlorenz/doctoc
 
* https://github.com/thlorenz/doctoc
Line 129: Line 110:
 
== WYSIWYM ==
 
== WYSIWYM ==
 
* http://daringfireball.net/projects/markdown/dingus
 
* http://daringfireball.net/projects/markdown/dingus
 +
  
 
* http://www.markdownviewer.com/
 
* http://www.markdownviewer.com/
 +
  
 
* https://stackedit.io/
 
* https://stackedit.io/
 
** https://github.com/benweet/stackedit
 
** https://github.com/benweet/stackedit
 +
  
 
* http://jrmoran.com/playground/markdown-live-editor/
 
* http://jrmoran.com/playground/markdown-live-editor/
 +
  
 
* http://markable.in/editor/
 
* http://markable.in/editor/
 +
  
 
* https://jbt.github.io/markdown-editor/
 
* https://jbt.github.io/markdown-editor/
 +
  
 
* http://jrmoran.com/playground/markdown-live-editor/
 
* http://jrmoran.com/playground/markdown-live-editor/
 +
  
 
* http://markdownlivepreview.com/
 
* http://markdownlivepreview.com/
 +
  
 
* http://georgeosddev.github.io/markdown-edit/
 
* http://georgeosddev.github.io/markdown-edit/
 +
  
 
== Configuration ==
 
== Configuration ==
 
* https://github.com/tj/mdconf#mdconf
 
* https://github.com/tj/mdconf#mdconf
 +
  
 
== JSON ==
 
== JSON ==
 
* http://beautifuldocs.com/
 
* http://beautifuldocs.com/
 +
 +
 
* https://github.com/scottstanfield/markdown-to-json
 
* https://github.com/scottstanfield/markdown-to-json
 +
 +
 
* https://github.com/sheremetyev/markdown-json
 
* https://github.com/sheremetyev/markdown-json
 +
  
 
* [https://github.com/apiaryio/mson Markdown Syntax for Object Notation] (MSON) - This document is a proposal of Markdown syntax for JSON & JSON Schema.
 
* [https://github.com/apiaryio/mson Markdown Syntax for Object Notation] (MSON) - This document is a proposal of Markdown syntax for JSON & JSON Schema.
 +
  
 
== Systems ==
 
== Systems ==
 
* http://laktek.github.io/punch/
 
* http://laktek.github.io/punch/
 
** http://css.dzone.com/articles/generate-websites-json
 
** http://css.dzone.com/articles/generate-websites-json
 +
  
 
* https://github.com/trulia/hologram
 
* https://github.com/trulia/hologram
 +
  
 
* http://jacobrask.github.io/styledocco/
 
* http://jacobrask.github.io/styledocco/
 +
  
 
== WikiCreole ==
 
== WikiCreole ==
 
* http://wikicreole.org/
 
* http://wikicreole.org/
 +
 
* http://en.wikipedia.org/wiki/Creole_(markup)
 
* http://en.wikipedia.org/wiki/Creole_(markup)
  
Line 172: Line 173:
  
 
* http://www.wikicreole.org/wiki/Converters
 
* http://www.wikicreole.org/wiki/Converters
 +
  
 
== to sort ==
 
== to sort ==
Line 187: Line 189:
 
The Markdown Presentation Service for everyone on GitHub, GitLab, and  
 
The Markdown Presentation Service for everyone on GitHub, GitLab, and  
 
Bitbucket. Using the tools you already know and love ~ Markdown + Git.
 
Bitbucket. Using the tools you already know and love ~ Markdown + Git.
 +
  
 
== XMPP ==
 
== XMPP ==
Line 192: Line 195:
  
  
== Software ==
+
== Editors ==
 
* http://codeboje.de/markdown-editors/
 
* http://codeboje.de/markdown-editors/
  
Line 265: Line 268:
 
=== markx ===
 
=== markx ===
 
* https://github.com/yoavram/markx - Markdown editor for scientific writing. Batteries included.
 
* https://github.com/yoavram/markx - Markdown editor for scientific writing. Batteries included.
 +
  
 
== Services ==
 
== Services ==
Line 297: Line 301:
  
 
* http://fuckyeahmarkdown.com/ [https://news.ycombinator.com/item?id=12460640] - WEB 2 MARKDOWN
 
* http://fuckyeahmarkdown.com/ [https://news.ycombinator.com/item?id=12460640] - WEB 2 MARKDOWN
 +
  
 
== Presentation ==
 
== Presentation ==
Line 317: Line 322:
  
 
== CV / résumé ==
 
== CV / résumé ==
 +
 +
=== resume ===
 +
* https://github.com/mwhite/resume - a simple Markdown resumé template, LaTeX header, and pre-processing script that can be used with Pandoc to generate professional-looking PDF and HTML output.
 +
 +
 
=== HackMyREsume ===
 
=== HackMyREsume ===
 
* https://github.com/hacksalot/HackMyResume
 
* https://github.com/hacksalot/HackMyResume
Line 328: Line 338:
  
 
== Conversion ==
 
== Conversion ==
See [[#Pandoc]]
+
See [[Documents]]
 +
 
  
 
* https://github.com/alanshaw/markdown-pdf
 
* https://github.com/alanshaw/markdown-pdf
 +
  
 
* https://github.com/lise-henry/crowbook
 
* https://github.com/lise-henry/crowbook
 +
  
 
* https://github.com/youurayy/gfms/network
 
* https://github.com/youurayy/gfms/network
Line 338: Line 351:
  
 
* https://www.npmjs.com/package/github-markdown-to-png
 
* https://www.npmjs.com/package/github-markdown-to-png
 +
  
 
  install imagemagick
 
  install imagemagick
Line 355: Line 369:
  
 
* [https://allmark.io/ allmark] - a file-system-centric markdown web server. You can point it at any directory that contains markdown files and it will immediately start a web-server that serves the rendered HTML content of the markdown file to you. And it will not only render the markdown files in your directory as HTML, but it will also add everything that it needed for a complete website: Navigation, Full-text Search, Theming, Sitemap, RSS, Tags, … on-the-fly with websocket-based live-reload. Animation: Cloning allmark from github, building it and taking it out for a test run on the allmark repository itself, and thanks to the power of go all of this is super fast and done with a single standalone application.
 
* [https://allmark.io/ allmark] - a file-system-centric markdown web server. You can point it at any directory that contains markdown files and it will immediately start a web-server that serves the rendered HTML content of the markdown file to you. And it will not only render the markdown files in your directory as HTML, but it will also add everything that it needed for a complete website: Navigation, Full-text Search, Theming, Sitemap, RSS, Tags, … on-the-fly with websocket-based live-reload. Animation: Cloning allmark from github, building it and taking it out for a test run on the allmark repository itself, and thanks to the power of go all of this is super fast and done with a single standalone application.
 +
 +
== Viewers ==
 +
 +
=== Terminal ===
 +
 +
* https://github.com/axiros/terminal_markdown_viewer - Python based Markdown viewer for the terminal might be a good option.
 +
 +
 +
* https://github.com/visit1985/mdp - A command-line based markdown presentation tool. [https://news.ycombinator.com/item?id=8340731]

Revision as of 16:34, 16 April 2019

General

  • WP: Markdown - a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. Since the initial description of Markdown contained ambiguities and unanswered questions, the implementations that appeared over the years have subtle differences and many come with syntax extensions.



Variations


In March 2016 RFC 7763 and RFC 7764 were published. RFC 7763 introduced MIME type text/markdown with the original variant. RFC 7764 discusses and registered the variants MultiMarkdown, GitHub Flavored Markdown (GFM), Pandoc, CommonMark, and Markdown Extra among others.




CommonMark

  • https://github.com/karlcow/markdown-testsuite - This project was initiated to provide a test suite for Markdown markup, and eventually create a specification from this test results. A part of of the community has started a new endeavor which seems to get traction as CommonMark.

GitHub


R Markdown

Markdown Extra

  • Markdown Extra - an extension to PHP Markdown implementing some features currently not available with the plain Markdown syntax. Markdown Extra is available as a separate parser class in PHP Markdown Lib.

Markdown Extended

Fountain

  • Fountain - a simple markup syntax for writing, editing and sharing screenplays in plain, human-readable text. Fountain allows you to work on your screenplay anywhere, on any computer or tablet, using any software that edits text files.

Tools

  • Lorem Markdownum - Inspired by the many excellent lorem ipsum generators, this simple webapp generates placeholder text. However, instead of generating plain text, this generator gives you structured text in the form of markdown. In order to do so, it uses Markov Chains and many heuristics.

Browser

  • Markdown Here - a Google Chrome, Firefox, Safari, Opera, and Thunderbird extension that lets you write email in Markdown and render them before sending. It also supports syntax highlighting (just specify the language in a fenced code block).


CSS / JS

  • Markdown.css - CSS to make HTML markup look like plain-text markdown.


  • PageDown - the JavaScript Markdown previewer used on Stack Overflow and the rest of the Stack Exchange network. It includes a Markdown-to-HTML converter and an in-page Markdown editor with live preview.





Table of Contents


cat ~/projects/Dockerfile.vim/README.md | ./gh-md-toc -
 * [Dockerfile.vim](#dockerfilevim)
 * [Screenshot](#screenshot)
 * [Installation](#installation)
       * [OR using Pathogen:](#or-using-pathogen)
       * [OR using Vundle:](#or-using-vundle)
 * [License](#license)



WYSIWYM










Configuration


JSON





Systems




WikiCreole


to sort


The Markdown Presentation Service for everyone on GitHub, GitLab, and Bitbucket. Using the tools you already know and love ~ Markdown + Git.


XMPP


Editors

ReText


Remarkable

UberWriter

ghostwriter

  • ghostwriter - a Windows and Linux text editor for Markdown, which is a plain text markup format created by John Gruber. For more information about Markdown, please visit John Gruber’s website at http://www.daringfireball.net. ghostwriter provides a relaxing, distraction-free writing environment, whether your masterpiece be that next blog post, your school paper, or your NaNoWriMo novel. For a tour of its features, please visit the ghostwriter project page.

Haroopad

  • Haroopad - markdown enabled document processor for creating web-friendly documents.You can author professional-looking documents of various formats: blog posts, slides, presentations, reports, email and more.Haroopad gives you the same editing experience regardless of the platform you are working on. It runs on all three major operating systems—Windows, Mac OS X, and Linux.

monod

  • monod - an Open Source React-based Markdown editor. You can use it any time (offline mode), share documents with anyone (encrypted), and render your content with a set of templates. This editor is brought to you by the good folks at TailorDev, as part of a Le lab experiment (#2).

Abricotine

Moeditor

CuteMarkEd


Typora

  • Typora - a markdown editor, markdown reader, will give you a seamless experience as both a reader and a writer. It removes the preview window, mode switcher, syntax symbols of markdown source code, and all other unnecessary distractions. Replace them with a real live preview feature to help you concentrate the content itself. [10]


gdocs2md

markdrive


gedit

Editor.md

remark

  • remark - an ecosystem of plugins for processing markdown built on unified. The project parses and compiles markdown, and lets programs process markdown without ever compiling to HTML (it can though). Powered by plugins to do all kinds of things: check markdown code style, transform safely to React, add a table of contents, or compile to man pages.

Mark Text

Zettlr

markx


Services



Presentation



CV / résumé

resume

  • https://github.com/mwhite/resume - a simple Markdown resumé template, LaTeX header, and pre-processing script that can be used with Pandoc to generate professional-looking PDF and HTML output.


HackMyREsume

requires wkhtmltopdf


Conversion

See Documents






install imagemagick
 
sudo npm install -g phantomjs-prebuilt github-markdown-to-png
 
github-markdown-to-png -i yourmarkdownfile.md
github-markdown-to-png -i yourmarkdownfile.md -o png-dir



  • https://github.com/joeyespo/grip - a command-line server application written in Python that uses the GitHub markdown API to render a local readme file. The styles come directly from GitHub, so you'll know exactly how it will appear. Changes you make to the Readme will be instantly reflected in the browser without requiring a page refresh.


  • allmark - a file-system-centric markdown web server. You can point it at any directory that contains markdown files and it will immediately start a web-server that serves the rendered HTML content of the markdown file to you. And it will not only render the markdown files in your directory as HTML, but it will also add everything that it needed for a complete website: Navigation, Full-text Search, Theming, Sitemap, RSS, Tags, … on-the-fly with websocket-based live-reload. Animation: Cloning allmark from github, building it and taking it out for a test run on the allmark repository itself, and thanks to the power of go all of this is super fast and done with a single standalone application.

Viewers

Terminal