|
|
|
|
52
|
|
52
|
|
53
|
* For unordered lists, use asterisk, at least for the first level.
|
53
|
* For unordered lists, use asterisk, at least for the first level.
|
54
|
|
54
|
|
55
|
- * Optimal spacing is 1 space, asterisk, 2 spaces, e.g. ` * foo`.
|
|
|
|
|
55
|
+ * Optimal spacing is 1 space, asterisk, 2 spaces, e.g. ` * foo`.
|
56
|
|
56
|
|
57
|
* For ordered lists, optimal spacing is one or zero spaces in front
|
57
|
* For ordered lists, optimal spacing is one or zero spaces in front
|
58
|
- of the number, then one space, e.g. ` 9. Foo`, then `10. Bar`.
|
|
|
|
|
58
|
+ of the number, then one space, e.g. ` 9. Foo`, then `10. Bar`.
|
59
|
|
59
|
|
60
|
|
60
|
|
61
|
Jargon names
|
61
|
Jargon names
|
|
|
|
|
73
|
-----
|
73
|
-----
|
74
|
|
74
|
|
75
|
* Use reference-style, i.e. `[link text][1]` and then, after paragraph
|
75
|
* Use reference-style, i.e. `[link text][1]` and then, after paragraph
|
76
|
- (or later if that makes sense), use ` [1]: http://www.foo.../`.
|
|
|
|
|
76
|
+ (or later if that makes sense), use ` [1]: http://www.foo.../`.
|
77
|
|
77
|
|
78
|
* Note that you don't need to use numbers: keyword is OK (even spaced),
|
78
|
* Note that you don't need to use numbers: keyword is OK (even spaced),
|
79
|
but *keep it consistent within the document*.
|
79
|
but *keep it consistent within the document*.
|
80
|
|
80
|
|
81
|
* You can also use `[link][]`; here the keyword = link text (i.e.
|
81
|
* You can also use `[link][]`; here the keyword = link text (i.e.
|
82
|
- ` [link]: http://whatever` would follow).
|
|
|
|
|
82
|
+ ` [link]: http://whatever` would follow).
|
83
|
|
83
|
|
84
|
* Links can be local (although I have only used this in Github).
|
84
|
* Links can be local (although I have only used this in Github).
|
85
|
|
85
|
|