diff options
| author | Egor Tensin <egor@tensin.name> | 2026-06-06 22:23:54 +0200 |
|---|---|---|
| committer | Egor Tensin <egor@tensin.name> | 2026-06-06 22:24:45 +0200 |
| commit | be5e0048913797f2ef91065908730da025113c34 (patch) | |
| tree | dd16e4908bb93953dbc823d7624f76c363a00bf4 /src/_notes/markdown.md | |
| parent | bump dependencies (diff) | |
| download | blog-be5e0048913797f2ef91065908730da025113c34.tar.gz blog-be5e0048913797f2ef91065908730da025113c34.zip | |
move Jekyll source files to src/
Diffstat (limited to 'src/_notes/markdown.md')
| -rw-r--r-- | src/_notes/markdown.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/src/_notes/markdown.md b/src/_notes/markdown.md new file mode 100644 index 0000000..39cbbd9 --- /dev/null +++ b/src/_notes/markdown.md @@ -0,0 +1,44 @@ +--- +title: Markdown +subtitle: 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 long, 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' `cmd`, 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 links over inline links. +Omit the second pair of brackets `[]` entirely where appropriate. +For example, [Google] is preferred over both [Google](https://ya.ru) and +[I'm feeling lucky][google] (see [this document's source]). +* First- and second-level headers are underlined with strings of `=` and `-`. +The number of `=`/`-` 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 according to the spec + (https://github.github.com/gfm/#list-items), i.e. the column of the first + non-whitespace character in the item + 4. + +* Don't mix fenced code blocks with indented code blocks in a single document. + +| In a table, | the first | row | is underlined. +| ----------- | --------- | ----- | -------------- +| Leftmost | vertical | lines | are required. +| Rightmost | vertical | lines | are omitted. +{: .table .table-bordered } + +[Google]: https://www.google.com/ +[this document's source]: https://raw.githubusercontent.com/{{ site.github.repository_nwo }}/gh-pages/{{ page.path }} |
