Chris Chambers avatar Chris Chambers committed 0c21947

Adding an example syntax page

Comments (0)

Files changed (1)

examples/4=>mango-markdown-syntax.text

+date:	23 May 2010
+time:	10:48pm
+tags:	Markdown, Mango, syntax
+
+| Mango Markdown Syntax Reference
+| ===============================
+
+| This is a reference list of *all* of the additional mango syntax hooks that will work on a mango blog.
+| See the [basic markdown syntax] for an introduction to markdown, John Gruber's [markdown syntax][DF]
+| page for an explanation of all of the Markdown syntax, and [PHP Markdown Extra][PhpME], an extension to
+| markdown to add additional functionality (Mango actually uses [Python-Markdown Extra][PythonME] but the
+| syntax is largely the same)
+
+| [DF]: http://daringfireball.net/projects/markdown/
+| [PhpME]: http://michelf.com/projects/php-markdown/extra/
+| [PythonME]: http://www.freewisdom.org/projects/python-markdown/Extra
+
+**Note:** Like all mango powered documents the markdown [source]('./m/') code for this can be seen by
+adding 'm/' to the end of the url
+
+Chevrons???
+-----------
+
+"\<<" and "\>>" are both replaced by "<<" and ">>" in Mango, allowing the easy use of <<them>>. Escape
+with a "\\".
+
+Excerpt
+-------
+
+To control what section of you post will appear on an index page you can start each line that you want to appear
+with a "|". If no lines start with this then the entire text will be used
+
+Ellipsis
+--------
+
+Because "\..." can look ugly, it is replaced by "..." (ellipsis character, u2026) whenever you have three
+"." in a row, to avoid this simply type "\\\..."
+
+
+Filesize
+--------
+
+On a website it is generally nice to indicate the size of any files that you are linking to to download. If
+you use a markdown style link to a file on your server you can have Mango enter that filesize into your page,
+simply follow the link with "{{filesize}}"
+
+e.g. "Download the \[tiny calendar icon set\](/downloads/tiny-calendar-icon-set.zip) \{{ filesize }}" will
+render as "Download the [tiny calendar icon set](/downloads/tiny-calendar-icon-set.zip) ~1.3MB"
+
+Hyphen
+------
+
+In a sentance -- if one wants a brief interlude -- an em-dash with thin spaces on either side should be used.
+In mango you can simply type " \-\- " and it will be converted to " -- "
+
+Meta
+----
+
+TODO
+
+Updates
+-------
+
+If you want to update your post at a later date and indicate what was updated simply start each line of the update with
+"||", this will cause the updated section to be parsed by the update.dhtml template. The default template will simply
+wrap this in a div with a class of "update", allowing you to style it with css however you choose
+
+|| Update - see it in action here (Look at the source html, there is no styling by defualt at the moment)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.