A multilingual human-readable Markdown reference you can include in your projects.
CSS Erlang JavaScript
#9 Compare This branch is 30 commits ahead of edouard:master.
Latest commit 199dae8 Dec 11, 2013 @fletcher metadata variables
Permalink
Failed to load latest commit information.
ca
de look for CSS outside at root Apr 23, 2012
en move image Apr 23, 2012
es look for CSS outside at root Apr 23, 2012
fr "Envoyez-moi un e-mail" instead of "Envoyez-mopi un e-mail" Jun 5, 2012
images move image Apr 23, 2012
it Added italian localization Jun 6, 2012
javascripts Fix up HTML. Delete .po files as they are not needed any more. Aug 3, 2010
ru look for CSS outside at root Apr 23, 2012
sv look for CSS outside at root Apr 23, 2012
tr look for CSS outside at root Apr 23, 2012
LICENCE Initial commit Dec 29, 2009
MMD-Guide.html fix image as figure Apr 26, 2012
README.md I added my name to the README.md for the Italian translations. Jun 6, 2012
index.html metadata variables Dec 11, 2013
markdown-reference.css
mmd.png change image from Composer icon to more generic mmd; add margins to a… Oct 27, 2012

README.md

Human Markdown Reference

The Human Markdown Reference is a set of short, easy to understand HTML pages you can include in any project that uses Markdown.

Consider this a fork of Human Textile Reference.

It is not designed to be a complete reference. Just a quick guide for the layman. For detailed detailed markdown syntax, check the Markdown page at Daring Fireball.

It is perfect for including as a pop-up help window next to your textarea.

Example

You can see an example here.

How To Use

Copy markdown-reference to your project.

Add a help link to the reference:

HTML Snippet

You can format your text using 
<a href="markdown-reference/index.html" onclick="window.open(this.href,'/markdown_reference','height=400,width=600,scrollbars=1'); return false;">Markdown</a>.

Rails Snippet

You can format your text using
<%= link_to 'Markdown', '/markdown-reference/index.html', :popup => ['markdown_reference', 'height=400,width=600,scrollbars=1'] %>

Internationalization

You may need a different language than English. Human Markdown reference is current translated into:

  • Catalan
  • French
  • Russian
  • Spanish
  • Swedish

If you spot a mistake or want to contribute a new language, request an invitation to the translation project.

Add a help link to the reference:

HTML Snippet

You can format your text using 
<a href="markdown-reference/xx" onclick="window.open(this.href,'/markdown_reference/xx','height=400,width=600,scrollbars=1'); return false;">Markdown</a>.

where xx is the code of the locale you want to use.

Rails Snippet

You can format your text using
<%= link_to 'Markdown', "/markdown-reference/#{I18n.locale}", :popup => ['markdown_reference', 'height=400,width=600,scrollbars=1'] %>

Contributors

  • Alex Soulim (Russian translations),
  • Pere Joan Martorell (Catalan and Spanish translations)
  • Daniele Pitrolo (Italian translations).