tenno/scq
1
0
Fork 0
Code Issues Releases 2 Activity

Make documentation slightly more English

Browse source
This commit is contained in:
nabijaczleweli 2017-08-17 01:40:53 +02:00
parent 2181caf0c4
commit 1e33f2a766
No known key found for this signature in database
GPG key ID: BCFD0B018D2658F1
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
documentation
View file

@ -1,13 +1,13 @@
smu - a Simple Markup Language smu - a Simple Markup Language
============================== ==============================
_smu_ is a very simple and minimal markup language. It is designed for using in _smu_ is a very simple and minimal markup language. It is designed for use in
wiki-like environments. smu makes it very easy to write your documents on the wiki-like environments. smu makes it very easy to write your documents on the
fly and convert them into HTML. fly and convert them into HTML.
smu is capable to parse very large documents. As long as you avoid an huge smu is capable of parsing very large documents. It scales just great as long
amount of indents it scales just great. (This will be fixed in future releases as you avoid a huge amount of indents (yhis will be fixed in future releases
of smu) of smu).
Syntax Syntax
====== ======
@ -23,13 +23,13 @@ Inline pattern
There are several pattern you can use to highlight your text: There are several pattern you can use to highlight your text:
* Emphasis * Emphasis
* Surround your text with `*` or `_` to get *emphasis* text: * Surround your text with `*` or `_` to get *emphasised* text:
This *is* cool. This *is* cool.
This _is_ cool, too. This _is_ cool, too.
* Surround your text with `**` or `__` to get **strong** text: * Surround your text with `**` or `__` to get **strong** text:
This **is** cool. This **is** cool.
This __is__ cool, too. This __is__ cool, too.
* Surround your text with `***` or `___` to get ***strong and emphasis*** text: * Surround your text with `***` or `___` to get ***strong and emphasised*** text:
This ***is*** cool. This ***is*** cool.
This ___is___ cool, too. This ___is___ cool, too.
* But this example won't work as expected: * But this example won't work as expected:
@ -119,7 +119,7 @@ Defining ordered lists is also very easy:
3. Item 3 3. Item 3
It is possible to use any leading number you want. So if you don't want to keep It is possible to use any leading number you want. So if you don't want to keep
your list synchron, you simple can use any number. In this case it's your list synchronised, you simple can use any number. In this case it's
recommended to use `0.`, but it isn't mandatory. recommended to use `0.`, but it isn't mandatory.
0. Item 1 0. Item 1
@ -143,9 +143,9 @@ This will be the result in these example:
Code & Blockquote Code & Blockquote
----------------- -----------------
Use the `> ` as a line prefix for defining blockquotes. The blockquotes are Use the `> ` as a line prefix for defining blockquotes. Blockquotes are
interpreted. This makes it possible to embed links, headings and even other interpreted as well. This makes it possible to embed links, headings and even
quotes into a quote: other quotes into a quote:
> Hello > Hello
> This is a quote with a [link](http://s01.de/~gottox) > This is a quote with a [link](http://s01.de/~gottox)
@ -186,6 +186,7 @@ Other interesting stuff
<hr /> <hr />
Hello2</p> Hello2</p>
* You can escape the following pattern to avoid them from being interpreted: * You can escape the following pattern to avoid them from being interpreted:
\ ` * _ { } [ ] ( ) # + - . ! \ ` * _ { } [ ] ( ) # + - . !