aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorThunderMikey <mikecyj25@gmail.com>2018-03-22 10:57:55 +0000
committerThunderMikey <mikecyj25@gmail.com>2018-03-22 10:57:55 +0000
commit0306ae92399536c6ff3d16005dee8cf11992da6b (patch)
tree1395e0e63ec66a29c2cf1cd84c4cc5e4e5c0c2e0 /README.md
parent37fb9845f8b28f73c60370e9847117ddcbc7d584 (diff)
downloadFMark-0306ae92399536c6ff3d16005dee8cf11992da6b.tar.gz
FMark-0306ae92399536c6ff3d16005dee8cf11992da6b.zip
add doc ofr list
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3f79548..7d9d504 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,19 @@ at [CommonMark](http://spec.commonmark.org/0.27/).
A reference implementation of the simple markdown can be found [here](http://spec.commonmark.org/dingus/).
+### Lists
+
+* A list ends with two endlines, i.e., `\r\n\r\n`
+* List items are separated by one endline
+* List type is determined by the first item.
+ * `NUMBER ; DOT` will be ordered list
+ * ` - ` or ` * ` will be unordered list
+* If the first item does not start with `NUMDER;DOT;Space| "- " | "* "`, the list type will be default to unordered list
+* Ordered list start number is determined by the first item
+ * The subsequent counting is `+1` for each list item
+* Two spaces as one level of indentation.
+* A tab, `\t` character will be interpreted as four spaces, therefore two levels of indentation.
+
# Markdown extensions (not included in standard Markdown)
## Macros