summaryrefslogtreecommitdiffstatshomepage
path: root/markdown.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-10-08 23:23:23 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-10-08 23:23:23 +0300
commit15de698d1a6abd1d9da4befee7d54632d11ff54a (patch)
tree9055709c19e02ac004b29898a01d22ce73201f62 /markdown.md
downloadnotes-15de698d1a6abd1d9da4befee7d54632d11ff54a.tar.gz
notes-15de698d1a6abd1d9da4befee7d54632d11ff54a.zip
initial commit (compiled from a couple of Gists)
Diffstat (limited to 'markdown.md')
-rw-r--r--markdown.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/markdown.md b/markdown.md
new file mode 100644
index 0000000..8e25227
--- /dev/null
+++ b/markdown.md
@@ -0,0 +1,34 @@
+Markdown style guide
+====================
+
+* `diff`- and HTML-friendliness is valued over human-readability.
+* Every sentence starts on a new line ("semantic newlines").
+* Lines are at most 79 characters wide, not counting neither the carriage
+return, nor the line feed characters.
+ * Not 80 characters, because when you display a 80-character line with a
+line feed at the end in Windows's Command Prompt, an extra empty line is added.
+* No hanging indents in lists.
+ * Nested lists are indented with 4 spaces.
+ * No hanging indents in those also.
+ * Longer items wrap at 79 characters and continue from the leftmost
+character column.
+Additional sentences start there also.
+* Prefer reference-style linkes over inline links.
+Use implicit reference link names where appropriate, omitting the second pair
+of brackets `[]` entirely.
+* First- and second- level headers are underlined (with `=` and `-`).
+The number of `=` (or `-`) signs must be equal to the number of characters in
+the header.
+* File paths are enclosed in double quotes.
+Environment variable names are enclosed in a pair of backticks (\`) unless it's
+a part of a path.
+Executable names are enclosed in a pair of backticks (\`) unless it's a part of
+a path, a link or a header.
+* Code blocks are indented with 4 spaces.
+
+ Code blocks inside lists are indented with 4 * (list nesting level + 1) spaces.
+
+In a table, | the | first row | is underlined.
+----------- | --- | --------- | --------------
+Leftmost | and | rightmost | vertical
+lines | are | omitted. |