Merge pull request #1193 from pjkaufman/master

Release Prep

docs/docs/settings/content-rules.md

@@ -8,15 +8,15 @@
 
 Alias: `auto-correct-common-misspellings`
 
-Uses a dictionary of common misspellings to automatically convert them to their proper spellings. See [auto-correct map](https://github.com/platers/obsidian-linter/tree/master/src/utils/auto-correct-misspellings.ts) for the full list of auto-corrected words. **Note: this list can work on text from multiple languages, but this list is the same no matter what language is currently in use.**
+Uses a dictionary of common misspellings to automatically convert them to their proper spellings. See <a href="https://github.com/platers/obsidian-linter/tree/master/src/utils/default-misspellings.md">auto-correct map</a> for the full list of auto-corrected words. <b>Note: this list can work on text from multiple languages, but this list is the same no matter what language is currently in use.</b>
 
 ### Options
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
 | `Ignore Words` | A comma separated list of lowercased words to ignore when auto-correcting | N/A |  |
 | `Skip Words with Multiple Capitals` | Will skip any files that have a capital letter in them other than as the first letter of the word. Acronyms and some other words can benefit from this. It may cause issues with proper nouns being properly fixed. | N/A | false |
-| `Extra Auto-Correct Source Files` | These are files that have a markdown table in them that have the initial word and the word to correct it to (these are case insensitive corrections). **Note: the tables used should have the starting and ending `|` indicators present for each line.** | N/A |  |
+| `Extra Auto-Correct Source Files` | These are files that have a markdown table in them that have the initial word and the word to correct it to (these are case insensitive corrections). <b>Note: the tables used should have the starting and ending <code>\|</code> indicators present for each line.</b> | N/A |  |
 
 ### Additional Info
 
@@ -281,7 +281,7 @@ Add a default language to code fences that do not have a language specified.
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
-| `Programming Language` | Leave empty to do nothing. Languages tags can be found [here](https://prismjs.com/#supported-languages). | N/A |  |
+| `Programming Language` | Leave empty to do nothing. Languages tags can be found <a href="https://prismjs.com/#supported-languages">here</a>. | N/A |  |
 
 
 
@@ -606,14 +606,15 @@ After:
 
 Alias: `ordered-list-style`
 
-Makes sure that ordered lists follow the style specified. **Note: that 2 spaces or 1 tab is considered to be an indentation level.**
+Makes sure that ordered lists follow the style specified. <b>Note: that 2 spaces or 1 tab is considered to be an indentation level.</b>
 
 ### Options
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
-| `Number Style` | The number style used in ordered list indicators | `ascending`: Makes sure ordered list items are ascending (i.e. 1, 2, 3, etc.)<br/><br/>`lazy`: Makes sure ordered list item indicators all are the number 1 | `ascending` |
+| `Number Style` | The number style used in ordered list indicators | `ascending`: Makes sure ordered list items are ascending (i.e. 1, 2, 3, etc.)<br/><br/>`lazy`: Makes sure ordered list item indicators all are the same<br/><br/>`preserve`: Preserves ordered list item indicators as they are | `ascending` |
 | `Ordered List Indicator End Style` | The ending character of an ordered list indicator | `.`: Makes sure ordered list items indicators end in '.' (i.e `1.`)<br/><br/>`)`: Makes sure ordered list item indicators end in ')' (i.e. `1)`) | `.` |
+| `Preserve Starting Number` | Whether to preserve the starting number of an ordered list. This can be used to have an ordered list that has content in between the ordered list items. | N/A | `undefined` |
 
 
 
@@ -741,6 +742,126 @@ After:
 1) Item 3
 ``````
 </details>
+<details><summary>Ordered lists have list items set to ascending numerical order using initial indicator number when Number Style is `ascending` and `preserveStart` is enabled</summary>
+
+Before:
+
+`````` markdown
+1. Item 1
+2. Item 2
+4. Item 3
+
+Some text here
+
+4. Item 4
+5. Item 5
+7. Item 6
+``````
+
+After:
+
+`````` markdown
+1. Item 1
+2. Item 2
+3. Item 3
+
+Some text here
+
+4. Item 4
+5. Item 5
+6. Item 6
+``````
+</details>
+<details><summary>Nested ordered lists have list items set to ascending numerical order using initial indicator number when Number Style is `ascending` and `preserveStart` is enabled</summary>
+
+Before:
+
+`````` markdown
+4. Item 4
+2. Item 5
+  2. Subitem 2
+  5. Subitem 3
+  2. Subitem 4
+4. Item 6
+``````
+
+After:
+
+`````` markdown
+4. Item 4
+5. Item 5
+  2. Subitem 2
+  3. Subitem 3
+  4. Subitem 4
+6. Item 6
+``````
+</details>
+<details><summary>Ordered lists have list items set to initial indicator number when Number Style is `lazy` and `preserveStart` is enabled</summary>
+
+Before:
+
+`````` markdown
+2. Item 2
+5. Item 3
+4. Item 4
+``````
+
+After:
+
+`````` markdown
+2. Item 2
+2. Item 3
+2. Item 4
+``````
+</details>
+<details><summary>Nested ordered lists have list items set to initial indicator number when Number Style is `lazy` and `preserveStart` is enabled</summary>
+
+Before:
+
+`````` markdown
+4. Item 4
+2. Item 5
+  2. Subitem 2
+  5. Subitem 3
+  2. Subitem 4
+4. Item 6
+``````
+
+After:
+
+`````` markdown
+4. Item 4
+4. Item 5
+  2. Subitem 2
+  2. Subitem 3
+  2. Subitem 4
+4. Item 6
+``````
+</details>
+<details><summary>Ordered lists items are not modified when Number Style is `preserve`</summary>
+
+Before:
+
+`````` markdown
+4. Item 4
+2. Item 5
+  2. Subitem 2
+  5. Subitem 3
+  2. Subitem 4
+4. Item 6
+``````
+
+After:
+
+`````` markdown
+4. Item 4
+2. Item 5
+  2. Subitem 2
+  5. Subitem 3
+  2. Subitem 4
+4. Item 6
+``````
+</details>
 
 ## Proper Ellipsis
 
@@ -779,9 +900,9 @@ Updates the quotes in the body content to be updated to the specified single and
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
-| `Enable `Single Quote Style`` | Specifies that the selected single quote style should be used. | N/A | `true` |
+| `Enable <code>Single Quote Style</code>` | Specifies that the selected single quote style should be used. | N/A | `true` |
 | `Single Quote Style` | The style of single quotes to use. | `''`: Uses "'" instead of smart single quotes<br/><br/>`‘’`: Uses "‘" and "’" instead of straight single quotes | `''` |
-| `Enable `Double Quote Style`` | Specifies that the selected double quote style should be used. | N/A | `true` |
+| `Enable <code>Double Quote Style</code>` | Specifies that the selected double quote style should be used. | N/A | `true` |
 | `Double Quote Style` | The style of double quotes to use. | `""`: Uses '"' instead of smart double quotes<br/><br/>`“”`: Uses '“' and '”' instead of straight double quotes | `""` |
 
 

docs/docs/settings/footnote-rules.md

@@ -93,7 +93,7 @@ Maecenas malesuada dignissim purus ac volutpat.
 
 Alias: `re-index-footnotes`
 
-Re-indexes footnote keys and footnote, based on the order of occurrence. **Note: This rule does _not_ work if there is more than one footnote for a key.**
+Re-indexes footnote keys and footnote, based on the order of occurrence. <b>Note: This rule does <i>not</i> work if there is more than one footnote for a key.</b>
 
 
 

docs/docs/settings/heading-rules.md

@@ -309,7 +309,7 @@ After:
 
 Alias: `remove-trailing-punctuation-in-heading`
 
-Removes the specified punctuation from the end of headings making sure to ignore the semicolon at the end of [HTML entity references](https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references).
+Removes the specified punctuation from the end of headings making sure to ignore the semicolon at the end of <a href="https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references">HTML entity references</a>.
 
 ### Options
 

docs/docs/settings/spacing-rules.md

@@ -172,7 +172,7 @@ After:
 
 Alias: `empty-line-around-blockquotes`
 
-Ensures that there is an empty line around blockquotes unless they start or end a document. **Note: an empty line is either one less level of nesting for blockquotes or a newline character.**
+Ensures that there is an empty line around blockquotes unless they start or end a document. <b>Note: an empty line is either one less level of nesting for blockquotes or a newline character.</b>
 
 
 
@@ -512,7 +512,7 @@ Content
 
 Alias: `empty-line-around-math-blocks`
 
-Ensures that there is an empty line around math blocks using `Number of Dollar Signs to Indicate a Math Block` to determine how many dollar signs indicates a math block for single-line math.
+Ensures that there is an empty line around math blocks using <code>Number of Dollar Signs to Indicate a Math Block</code> to determine how many dollar signs indicates a math block for single-line math.
 
 
 
@@ -948,7 +948,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit.
 
 Alias: `move-math-block-indicators-to-their-own-line`
 
-Move all starting and ending math block indicators to their own lines using `Number of Dollar Signs to Indicate a Math Block` to determine how many dollar signs indicates a math block for single-line math.
+Move all starting and ending math block indicators to their own lines using <code>Number of Dollar Signs to Indicate a Math Block</code> to determine how many dollar signs indicates a math block for single-line math.
 
 
 
@@ -1328,7 +1328,7 @@ After:
 
 Alias: `remove-space-around-characters`
 
-Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). **Note: this may causes issues with markdown format in some cases.**
+Ensures that certain characters are not surrounded by whitespace (either single spaces or a tab). <b>Note: this may causes issues with markdown format in some cases.</b>
 
 ### Options
 
@@ -1430,14 +1430,14 @@ After:
 
 Alias: `remove-space-before-or-after-characters`
 
-Removes space before the specified characters and after the specified characters. **Note: this may causes issues with markdown format in some cases.**
+Removes space before the specified characters and after the specified characters. <b>Note: this may causes issues with markdown format in some cases.</b>
 
 ### Options
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
-| `Remove Space Before Characters` | Removes space before the specified characters. **Note: using `{` or `}` in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.** | N/A | `,!?;:).’”]` |
-| `Remove Space After Characters` | Removes space after the specified characters. **Note: using `{` or `}` in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.** | N/A | `¿¡‘“([` |
+| `Remove Space Before Characters` | Removes space before the specified characters. <b>Note: using <code>{</code> or <code>}</code> in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.</b> | N/A | `,!?;:).’”]` |
+| `Remove Space After Characters` | Removes space after the specified characters. <b>>Note: using <code>{</code> or <code>}</code> in the list of characters will unexpectedly affect files as it is used in the ignore syntax behind the scenes.</b> | N/A | `¿¡‘“([` |
 
 
 
@@ -1513,14 +1513,14 @@ After:
 
 Alias: `space-between-chinese-japanese-or-korean-and-english-or-numbers`
 
-Ensures that Chinese, Japanese, or Korean and English or numbers are separated by a single space. Follows these [guidelines](https://github.com/sparanoid/chinese-copywriting-guidelines)
+Ensures that Chinese, Japanese, or Korean and English or numbers are separated by a single space. Follows these <a href="https://github.com/sparanoid/chinese-copywriting-guidelines">guidelines</a>
 
 ### Options
 
 | Name | Description | List Items | Default Value |
 | ---- | ----------- | ---------- | ------------- |
-| `English Punctuations and Symbols Before CJK` | The list of non-letter punctuation and symbols to consider to be from English when found before Chinese, Japanese, or Korean characters. **Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.** | N/A | `-+;:'"°%$)]` |
-| `English Punctuations and Symbols After CJK` | The list of non-letter punctuation and symbols to consider to be from English when found after Chinese, Japanese, or Korean characters. **Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.** | N/A | `-+'"([¥$` |
+| `English Punctuations and Symbols Before CJK` | The list of non-letter punctuation and symbols to consider to be from English when found before Chinese, Japanese, or Korean characters. <b>Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.</b> | N/A | `-+;:'"°%$)]` |
+| `English Punctuations and Symbols After CJK` | The list of non-letter punctuation and symbols to consider to be from English when found after Chinese, Japanese, or Korean characters. <b>Note: "*" is always considered to be English and is necessary for handling some markdown syntaxes properly.</b> | N/A | `-+'"([¥$` |