From 499a8607b025644d331cff41556d0845ffe5e42e Mon Sep 17 00:00:00 2001 From: chee Date: Tue, 19 Jan 2021 16:11:52 +0000 Subject: [PATCH] initial commit --- readme.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..3005839 --- /dev/null +++ b/readme.md @@ -0,0 +1,57 @@ +# ATX headings only + +## paragraphs + +paragraphs are separated by 2 newlines +a single newline continues the same paragraph + +hard line breaks\ +are added with a backslash + +## lists + +1. an ordered list starts with a number and a dot + +- an unordered list starts with a hyphen + +- for nested lists, + - use 4 spaces or one tab + +## codeblocks + +codeblocks are always fenced in backticks, the first token on the same line following the opening backticks is parsed as `lang` the rest is an info string, parsed as `meta` + +```lang info-string +code blocks are fenced in backticks +``` + +## inline + +**strong** text is surrounded by 2 asterisks + +_emphasis_ text is surrounded by 1 underline + +`code` is wrapped in backticks + +## thematic breaks + +--- + +thematic breaks are three or more asterisks + +## blockquotes + +> quotes start with one of these +> +> > quotes can be nested + +## links + +links are text in square brackets followed by a url in parens: + +[link text](https://url) + +### autolinks + + +