Code blocks need four spaces indentation instead of three
-
Skip empty lines at end of code blocks
-
Ignore single spaces around code spans
-
Keep HTML comments in output
-
Improved spec compliance for lists
-
Nesting code block in blockquotes works
-
“Empty” lines in lists behave identically, no matter how much whitespace they contain
-
No backslash escapes in code blocks
-
Use first number as start number for ordered lists
-
-
Added a simple test suite to check for compliance and avoid regressions
-
-
Inline patterns
-
There are several patterns you can use to highlight your text:
-
-
Emphasis
-
-
Surround your text with * or _ to get emphasised text:
-This is cool.
-This is cool, too.
-
Surround your text with ** or __ to get strong text:
-This is cool.
-This is cool, too.
-
Surround your text with *** or ___ to get strong and emphasised text:
-This is cool.
-This is cool, too.
-
But this example won’t work as expected:
-*Hello you*
-This is a wontfix bug because it would make the source too complex.
-Use this instead:
-Helloyou
-
-
inline Code
-
You can produce inline code by surrounding it with backticks.
-
Use rm -rf / if you’re a N00b.
-Use rm -rf / if you’re a N00b.
-Use rm -rf / if you’re a N00b.
-
Double and triple backticks can be used if the code itself contains backticks.
-
-
Titles
-
Creating titles in smu is very easy. There are two different syntax styles. The
-first is underlining with at least three characters:
-
Heading
-=======
-
-Topic
------
-
-
This is very intuitive and self explaining. The resulting sourcecode looks like
-this:
-
<h1>Heading</h1>
-<h2>Topic</h2>
-
-
Use the following prefixes if you don’t like underlining:
Use the > as a line prefix for defining blockquotes. Blockquotes are
-interpreted as well. This makes it possible to embed links, headings and even
-other quotes into a quote:
-
> Hello
-> This is a quote with a [link](http://s01.de/~gottox)
-
-
Result:
-
- Hello
- This is a quote with a link
-
-
You can define a code block with a leading Tab or with 4 leading spaces
-
this.is(code)
-
- this.is(code, too)
-
-
Result:
- this.is(code)
- this.is(code, too)
-
-
Please note that you can’t use HTML or smu syntax in a code block.
-
Another way to write code blocks is to use code fences:
-
```json
-{"some": "code"}
-```
-
-
This has two advantages:
-* The optional language identifier will be turned into a language- class name
-* You can keep the original indentation which helps when doing copy & paste
-
Tables
-
Tables can be generated with the following syntax:
To align the content of table cells, use |:--| for left, |--:| for right
-and |:--:| for centered alignment in the row which separates the header from
-the table body.
-
| Heading1 | Heading2 | Heading3 |
-| :------- | :------: | -------: |
-| Left | Center | Right |
-
-
Footnotes
-
Here is an example of using Markdown footnotes1. And incase you were looking for more examples, here is another one2.
-
Other interesting stuff
-
-
to insert a horizontal rule simple add - - - into an empty line:
-
Hello
-
-
Hello2
-
Result:
-
-Hello
-
-
Hello2
-
Any ASCII punctuation character may escaped by precedeing them with a
-backslash to avoid them being interpreted:
-
!”#$%&’()*+,-./:;<=>?@[]^_`{|}~\
-
To force a linebreak simple add two spaces to the end of the line:
-
No linebreak
-here.
-But here is
-one.
-
-
embed HTML
-
You can include arbitrary HTML code in your documents. The HTML will be
-passed through to the resulting document without modification. This is a good
-way to work around features that are missing in smu. If you don’t want this
-behaviour, use the -n flag when executing smu to stricly escape the HTML
-tags.