Skip to content
A multilingual human-readable Markdown reference you can include in your projects.
JavaScript
Find file
Failed to load latest commit information.
ca
en
es
fr
images
javascripts
ru
stylesheets
sv
tr
LICENCE
README.md
index.html Fix up HTML. Delete .po files as they are not needed any more. Aug 3, 2010

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).
Something went wrong with that request. Please try again.