Content Rules
Auto-correct Common Misspellings
Alias: auto-correct-common-misspellings
Uses a dictionary of common misspellings to automatically convert them to their proper spellings. See auto-correct map 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.
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 |
Additional Info
How to Use Custom Misspellings
There is a default list of common misspellings that is used as the base for how this rule works. However, there may be instances where the user may want to add their own list of misspellings to handle. In those scenarios, they can add files to the list of files that have custom misspellings in them.
Format
A file that has custom misspellings in them can have any content in them. But the only content that will
be parsed as custom misspellings should be found in a two column table. For example the following table
will result in th
being replaced with the
and tht
being replaced with that
:
The following is a table with custom misspellings:
| Replace | With |
| ------- | ---- |
| th | the |
| tht | that |
Note
The first two lines of the table are skipped (the header and separator) and all rows after that
must start and end with a pipe (|
). If any do not start or end with a pipe or they have more
than 2 columns, then they will be skipped.
Current Limitations
- The list of custom replacements is only loaded automatically when the plugin first lints a file or when the file is added to the list of files that include custom misspellings
- There is an option to manually rerun the parse custom misspelling files from the Auto-Correct Common Misspellings settings
- There is no way to specify that a word is to always be capitalized
- This is due to how the auto-correct rule was designed as it sets the first letter of the replacement word to the case of the first letter of the word being replaced
Examples
Auto-correct misspellings in regular text, but not code blocks, math blocks, YAML, or tags
Before:---
key: absoltely
---
I absoltely hate when my codeblocks get formatted when they should not be.
```
# comments absoltely can be helpful, but they can also be misleading
```
Note that inline code also has the applicable spelling errors ignored: `absoltely`
$$
Math block absoltely does not get auto-corrected.
$$
The same $ defenately $ applies to inline math.
#defenately stays the same
---
key: absoltely
---
I absolutely hate when my codeblocks get formatted when they should not be.
```
# comments absoltely can be helpful, but they can also be misleading
```
Note that inline code also has the applicable spelling errors ignored: `absoltely`
$$
Math block absoltely does not get auto-corrected.
$$
The same $ defenately $ applies to inline math.
#defenately stays the same
Auto-correct misspellings keeps first letter's case
Before:Accodringly we made sure to update logic to make sure it would handle case sensitivity.
Accordingly we made sure to update logic to make sure it would handle case sensitivity.
Links should not be auto-corrected
Before:http://www.Absoltely.com should not be corrected
http://www.Absoltely.com should not be corrected
Auto-correct misspellings skips words with multiple capital letters in them if `Skip Words with Multiple Capitals` is Enabled
Before:HSA here will not be auto-corrected to Has since it has more than one capital letter.
aADD will not be converted to add.
But this also affects javaSrript(what should be JavaScript) and other proper names as well which will not be auto-corrected.
HSA here will not be auto-corrected to Has since it has more than one capital letter.
aADD will not be converted to add.
But this also affects javaSrript(what should be JavaScript) and other proper names as well which will not be auto-corrected.
Blockquote Style
Alias: blockquote-style
Makes sure the blockquote style is consistent.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
Style |
The style used on blockquote indicators | space : > indicator is followed by a spaceno space : >indicator is not followed by a space |
space |
Examples
When style = `space`, a space is added to blockquotes missing a space after the indicator
Before:>Blockquotes will have a space added if one is not present
> Will be left as is.
> Nested blockquotes are also updated
>>Nesting levels are handled correctly
>> Even when only partially needing updates
> >Updated as well
>>>>>>> Is handled too
> > >>> As well
> <strong>Note that html is not affected in blockquotes</strong>
> Blockquotes will have a space added if one is not present
> Will be left as is.
> Nested blockquotes are also updated
> > Nesting levels are handled correctly
> > Even when only partially needing updates
> > Updated as well
> > > > > > > Is handled too
> > > > > As well
> <strong>Note that html is not affected in blockquotes</strong>
When style = `no space`, spaces are removed after a blockquote indicator
Before:> Multiple spaces are removed
> > Nesting is handled
> > > > > Especially when multiple levels are involved
> >>> > Even when partially correct already, it is handled
>Multiple spaces are removed
>>Nesting is handled
>>>>>Especially when multiple levels are involved
>>>>>Even when partially correct already, it is handled
Convert Bullet List Markers
Alias: convert-bullet-list-markers
Converts common bullet list marker symbols to markdown list markers.
Examples
Converts •
Before:• item 1
• item 2
- item 1
- item 2
Converts §
Before:• item 1
§ item 2
§ item 3
- item 1
- item 2
- item 3
Default Language For Code Fences
Alias: default-language-for-code-fences
Add a default language to code fences that do not have a language specified.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
Programming Language |
Leave empty to do nothing. Languages tags can be found here. | N/A |
Examples
Add a default language `javascript` to code blocks that do not have a language specified
Before:```
var temp = 'text';
// this is a code block
```
```javascript
var temp = 'text';
// this is a code block
```
If a code block already has a language specified, do not change it
Before:```javascript
var temp = 'text';
// this is a code block
```
```javascript
var temp = 'text';
// this is a code block
```
Empty string as the default language will not add a language to code blocks
Before:```
var temp = 'text';
// this is a code block
```
```
var temp = 'text';
// this is a code block
```
Emphasis Style
Alias: emphasis-style
Makes sure the emphasis style is consistent.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
Style |
The style used to denote emphasized content | consistent : Makes sure the first instance of emphasis is the style that will be used throughout the documentasterisk : Makes sure * is the emphasis indicatorunderscore : Makes sure _ is the emphasis indicator |
consistent |
Examples
Emphasis indicators should use underscores when style is set to 'underscore'
Before:# Emphasis Cases
*Test emphasis*
* Test not emphasized *
This is *emphasized* mid sentence
This is *emphasized* mid sentence with a second *emphasis* on the same line
This is ***bold and emphasized***
This is ***nested bold** and ending emphasized*
This is ***nested emphasis* and ending bold**
**Test bold**
* List Item1 with *emphasized text*
* List Item2
# Emphasis Cases
_Test emphasis_
* Test not emphasized *
This is _emphasized_ mid sentence
This is _emphasized_ mid sentence with a second _emphasis_ on the same line
This is _**bold and emphasized**_
This is _**nested bold** and ending emphasized_
This is **_nested emphasis_ and ending bold**
**Test bold**
* List Item1 with _emphasized text_
* List Item2
Emphasis indicators should use asterisks when style is set to 'asterisk'
Before:# Emphasis Cases
_Test emphasis_
_ Test not emphasized _
This is _emphasized_ mid sentence
This is _emphasized_ mid sentence with a second _emphasis_ on the same line
This is ___bold and emphasized___
This is ___nested bold__ and ending emphasized_
This is ___nested emphasis_ and ending bold__
__Test bold__
# Emphasis Cases
*Test emphasis*
_ Test not emphasized _
This is *emphasized* mid sentence
This is *emphasized* mid sentence with a second *emphasis* on the same line
This is *__bold and emphasized__*
This is *__nested bold__ and ending emphasized*
This is __*nested emphasis* and ending bold__
__Test bold__
Emphasis indicators should use consistent style based on first emphasis indicator in a file when style is set to 'consistent'
Before:# Emphasis First Emphasis Is an Asterisk
*First emphasis*
This is _emphasized_ mid sentence
This is *emphasized* mid sentence with a second _emphasis_ on the same line
This is *__bold and emphasized__*
This is *__nested bold__ and ending emphasized*
This is **_nested emphasis_ and ending bold**
__Test bold__
# Emphasis First Emphasis Is an Asterisk
*First emphasis*
This is *emphasized* mid sentence
This is *emphasized* mid sentence with a second *emphasis* on the same line
This is *__bold and emphasized__*
This is *__nested bold__ and ending emphasized*
This is ***nested emphasis* and ending bold**
__Test bold__
Emphasis indicators should use consistent style based on first emphasis indicator in a file when style is set to 'consistent'
Before:# Emphasis First Emphasis Is an Underscore
**_First emphasis_**
This is _emphasized_ mid sentence
This is *emphasized* mid sentence with a second _emphasis_ on the same line
This is *__bold and emphasized__*
This is _**nested bold** and ending emphasized_
This is __*nested emphasis* and ending bold__
__Test bold__
# Emphasis First Emphasis Is an Underscore
**_First emphasis_**
This is _emphasized_ mid sentence
This is _emphasized_ mid sentence with a second _emphasis_ on the same line
This is ___bold and emphasized___
This is _**nested bold** and ending emphasized_
This is ___nested emphasis_ and ending bold__
__Test bold__
No Bare URLs
Alias: no-bare-urls
Encloses bare URLs with angle brackets except when enclosed in back ticks, square braces, or single or double quotes.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
No Bare URIs |
Attempts to enclose bare URIs with angle brackets except when enclosed in back ticks, square braces, or single or double quotes. | N/A | false |
Examples
Make sure that links are inside of angle brackets when not in single quotes('), double quotes("), or backticks(`)
Before:https://github.com
braces around url should stay the same: [https://github.com]
backticks around url should stay the same: `https://github.com`
Links mid-sentence should be updated like https://google.com will be.
'https://github.com'
"https://github.com"
<https://github.com>
links should stay the same: [](https://github.com)
https://gitlab.com
<https://github.com>
braces around url should stay the same: [https://github.com]
backticks around url should stay the same: `https://github.com`
Links mid-sentence should be updated like <https://google.com> will be.
'https://github.com'
"https://github.com"
<https://github.com>
links should stay the same: [](https://github.com)
<https://gitlab.com>
Angle brackets are added if the url is not the only text in the single quotes(') or double quotes(")
Before:[https://github.com some text here]
backticks around a url should stay the same: `https://github.com some text here`
single quotes around a url should stay the same, but only if the contents of the single quotes is the url: 'https://github.com some text here'
double quotes around a url should stay the same, but only if the contents of the double quotes is the url: "https://github.com some text here"
[<https://github.com> some text here]
backticks around a url should stay the same: `https://github.com some text here`
single quotes around a url should stay the same, but only if the contents of the single quotes is the url: '<https://github.com> some text here'
double quotes around a url should stay the same, but only if the contents of the double quotes is the url: "<https://github.com> some text here"
Multiple angle brackets at the start and or end of a url will be reduced down to 1
Before:<<https://github.com>
<https://google.com>>
<<https://gitlab.com>>
<https://github.com>
<https://google.com>
<https://gitlab.com>
Puts angle brackets around URIs when `No Bare URIs` is enabled
Before:obsidian://show-plugin?id=cycle-in-sidebar
<obsidian://show-plugin?id=cycle-in-sidebar>
Ordered List Style
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.
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.)lazy : Makes sure ordered list item indicators all are the samepreserve : 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. )) : 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 |
Examples
Ordered lists have list items set to ascending numerical order when Number Style is `ascending`.
Before:1. Item 1
2. Item 2
4. Item 3
Some text here
1. Item 1
1. Item 2
1. Item 3
1. Item 1
2. Item 2
3. Item 3
Some text here
1. Item 1
2. Item 2
3. Item 3
Nested ordered lists have list items set to ascending numerical order when Number Style is `ascending`.
Before:1. Item 1
2. Item 2
1. Subitem 1
5. Subitem 2
2. Subitem 3
4. Item 3
1. Item 1
2. Item 2
1. Subitem 1
2. Subitem 2
3. Subitem 3
3. Item 3
Ordered list in blockquote has list items set to '1.' when Number Style is `lazy`.
Before:> 1. Item 1
> 4. Item 2
> > 1. Subitem 1
> > 5. Subitem 2
> > 2. Subitem 3
> 1. Item 1
> 1. Item 2
> > 1. Subitem 1
> > 1. Subitem 2
> > 1. Subitem 3
Ordered list in blockquote has list items set to ascending numerical order when Number Style is `ascending`.
Before:> 1. Item 1
> 4. Item 2
> > 1. Subitem 1
> > 5. Subitem 2
> > 2. Subitem 3
> 1. Item 1
> 2. Item 2
> > 1. Subitem 1
> > 2. Subitem 2
> > 3. Subitem 3
Nested ordered list has list items set to '1)' when Number Style is `lazy` and Ordered List Indicator End Style is `)`.
Before:1. Item 1
2. Item 2
1. Subitem 1
5. Subitem 2
2. Subitem 3
4. Item 3
1) Item 1
1) Item 2
1) Subitem 1
1) Subitem 2
1) Subitem 3
1) Item 3
Ordered lists have list items set to ascending numerical order using initial indicator number when Number Style is `ascending` and `preserveStart` is enabled
Before:1. Item 1
2. Item 2
4. Item 3
Some text here
4. Item 4
5. Item 5
7. Item 6
1. Item 1
2. Item 2
3. Item 3
Some text here
4. Item 4
5. Item 5
6. Item 6
Nested ordered lists have list items set to ascending numerical order using initial indicator number when Number Style is `ascending` and `preserveStart` is enabled
Before:4. Item 4
2. Item 5
2. Subitem 2
5. Subitem 3
2. Subitem 4
4. Item 6
4. Item 4
5. Item 5
2. Subitem 2
3. Subitem 3
4. Subitem 4
6. Item 6
Ordered lists have list items set to initial indicator number when Number Style is `lazy` and `preserveStart` is enabled
Before:2. Item 2
5. Item 3
4. Item 4
2. Item 2
2. Item 3
2. Item 4
Nested ordered lists have list items set to initial indicator number when Number Style is `lazy` and `preserveStart` is enabled
Before:4. Item 4
2. Item 5
2. Subitem 2
5. Subitem 3
2. Subitem 4
4. Item 6
4. Item 4
4. Item 5
2. Subitem 2
2. Subitem 3
2. Subitem 4
4. Item 6
Ordered lists items are not modified when Number Style is `preserve`
Before:4. Item 4
2. Item 5
2. Subitem 2
5. Subitem 3
2. Subitem 4
4. Item 6
4. Item 4
2. Item 5
2. Subitem 2
5. Subitem 3
2. Subitem 4
4. Item 6
Proper Ellipsis
Alias: proper-ellipsis
Replaces three consecutive dots with an ellipsis.
Examples
Replacing three consecutive dots with an ellipsis.
Before:Lorem (...) Impsum.
Lorem (…) Impsum.
Quote Style
Alias: quote-style
Updates the quotes in the body content to be updated to the specified single and double quote styles.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
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‘’ : Uses "‘" and "’" instead of straight single quotes |
'' |
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“” : Uses '“' and '”' instead of straight double quotes |
"" |
Examples
Smart quotes used in file are converted to straight quotes when styles are set to `Straight`
Before:# Double Quote Cases
“There are a bunch of different kinds of smart quote indicators”
„More than you would think”
«Including this one for Spanish»
# Single Quote Cases
‘Simple smart quotes get replaced’
‚Another single style smart quote also gets replaced’
‹Even this style of single smart quotes is replaced›
# Double Quote Cases
"There are a bunch of different kinds of smart quote indicators"
"More than you would think"
"Including this one for Spanish"
# Single Quote Cases
'Simple smart quotes get replaced'
'Another single style smart quote also gets replaced'
'Even this style of single smart quotes is replaced'
Straight quotes used in file are converted to smart quotes when styles are set to `Smart`
Before:"As you can see, these double quotes will be converted to smart quotes"
"Common contractions are handled as well. For example can't is updated to smart quotes."
"Nesting a quote in a quote like so: 'here I am' is handled correctly"
'Single quotes by themselves are handled correctly'
Possessives are handled correctly: Pam's dog is really cool!
Templater commands are ignored: <% tp.date.now("YYYY-MM-DD", 7) %>
Be careful as converting straight quotes to smart quotes requires you to have an even amount of quotes
once possessives and common contractions have been dealt with. If not, it will throw an error.
“As you can see, these double quotes will be converted to smart quotes”
“Common contractions are handled as well. For example can’t is updated to smart quotes.”
“Nesting a quote in a quote like so: ‘here I am’ is handled correctly”
‘Single quotes by themselves are handled correctly’
Possessives are handled correctly: Pam’s dog is really cool!
Templater commands are ignored: <% tp.date.now("YYYY-MM-DD", 7) %>
Be careful as converting straight quotes to smart quotes requires you to have an even amount of quotes
once possessives and common contractions have been dealt with. If not, it will throw an error.
Remove Consecutive List Markers
Alias: remove-consecutive-list-markers
Removes consecutive list markers. Useful when copy-pasting list items.
Examples
Removing consecutive list markers.
Before:- item 1
- - copypasted item A
- item 2
- indented item
- - copypasted item B
- item 1
- copypasted item A
- item 2
- indented item
- copypasted item B
Remove Empty List Markers
Alias: remove-empty-list-markers
Removes empty list markers, i.e. list items without content.
Examples
Removes empty list markers.
Before:- item 1
-
- item 2
* list 2 item 1
*
* list 2 item 2
+ list 3 item 1
+
+ list 3 item 2
- item 1
- item 2
* list 2 item 1
* list 2 item 2
+ list 3 item 1
+ list 3 item 2
Removes empty ordered list markers.
Before:1. item 1
2.
3. item 2
1. list 2 item 1
2. list 2 item 2
3.
_Note that this rule does not make sure that the ordered list is sequential after removal_
1. item 1
3. item 2
1. list 2 item 1
2. list 2 item 2
_Note that this rule does not make sure that the ordered list is sequential after removal_
Removes empty checklist markers.
Before:- [ ] item 1
- [x]
- [ ] item 2
- [ ]
_Note that this will affect checked and uncheck checked list items_
- [ ] item 1
- [ ] item 2
_Note that this will affect checked and uncheck checked list items_
Removes empty list, checklist, and ordered list markers in callouts/blockquotes
Before:> Checklist in blockquote
> - [ ] item 1
> - [x]
> - [ ] item 2
> - [ ]
> Ordered List in blockquote
> > 1. item 1
> > 2.
> > 3. item 2
> > 4.
> Regular lists in blockquote
>
> - item 1
> -
> - item 2
>
> List 2
>
> * item 1
> *
> * list 2 item 2
>
> List 3
>
> + item 1
> +
> + item 2
> Checklist in blockquote
> - [ ] item 1
> - [ ] item 2
> Ordered List in blockquote
> > 1. item 1
> > 3. item 2
> Regular lists in blockquote
>
> - item 1
> - item 2
>
> List 2
>
> * item 1
> * list 2 item 2
>
> List 3
>
> + item 1
> + item 2
Remove Hyphenated Line Breaks
Alias: remove-hyphenated-line-breaks
Removes hyphenated line breaks. Useful when pasting text from textbooks.
Examples
Removing hyphenated line breaks.
Before:This text has a linebr‐ eak.
This text has a linebreak.
Remove Multiple Spaces
Alias: remove-multiple-spaces
Removes two or more consecutive spaces. Ignores spaces at the beginning and ending of the line.
Examples
Removing double and triple space.
Before:Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet.
Strong Style
Alias: strong-style
Makes sure the strong style is consistent.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
Style |
The style used to denote strong/bolded content | consistent : Makes sure the first instance of strong is the style that will be used throughout the documentasterisk : Makes sure ** is the strong indicatorunderscore : Makes sure __ is the strong indicator |
consistent |
Examples
Strong indicators should use underscores when style is set to 'underscore'
Before:# Strong/Bold Cases
**Test bold**
** Test not bold **
This is **bold** mid sentence
This is **bold** mid sentence with a second **bold** on the same line
This is ***bold and emphasized***
This is ***nested bold** and ending emphasized*
This is ***nested emphasis* and ending bold**
*Test emphasis*
* List Item1 with **bold text**
* List Item2
# Strong/Bold Cases
__Test bold__
** Test not bold **
This is __bold__ mid sentence
This is __bold__ mid sentence with a second __bold__ on the same line
This is *__bold and emphasized__*
This is *__nested bold__ and ending emphasized*
This is __*nested emphasis* and ending bold__
*Test emphasis*
* List Item1 with __bold text__
* List Item2
Strong indicators should use asterisks when style is set to 'asterisk'
Before:# Strong/Bold Cases
__Test bold__
__ Test not bold __
This is __bold__ mid sentence
This is __bold__ mid sentence with a second __bold__ on the same line
This is ___bold and emphasized___
This is ___nested bold__ and ending emphasized_
This is ___nested emphasis_ and ending bold__
_Test emphasis_
# Strong/Bold Cases
**Test bold**
__ Test not bold __
This is **bold** mid sentence
This is **bold** mid sentence with a second **bold** on the same line
This is _**bold and emphasized**_
This is _**nested bold** and ending emphasized_
This is **_nested emphasis_ and ending bold**
_Test emphasis_
Strong indicators should use consistent style based on first strong indicator in a file when style is set to 'consistent'
Before:# Strong First Strong Is an Asterisk
**First bold**
This is __bold__ mid sentence
This is __bold__ mid sentence with a second **bold** on the same line
This is ___bold and emphasized___
This is *__nested bold__ and ending emphasized*
This is **_nested emphasis_ and ending bold**
__Test bold__
# Strong First Strong Is an Asterisk
**First bold**
This is **bold** mid sentence
This is **bold** mid sentence with a second **bold** on the same line
This is _**bold and emphasized**_
This is ***nested bold** and ending emphasized*
This is **_nested emphasis_ and ending bold**
**Test bold**
Strong indicators should use consistent style based on first strong indicator in a file when style is set to 'consistent'
Before:# Strong First Strong Is an Underscore
__First bold__
This is **bold** mid sentence
This is **bold** mid sentence with a second __bold__ on the same line
This is **_bold and emphasized_**
This is ***nested bold** and ending emphasized*
This is ___nested emphasis_ and ending bold__
**Test bold**
# Strong First Strong Is an Underscore
__First bold__
This is __bold__ mid sentence
This is __bold__ mid sentence with a second __bold__ on the same line
This is ___bold and emphasized___
This is *__nested bold__ and ending emphasized*
This is ___nested emphasis_ and ending bold__
__Test bold__
Line Break Between Lines with Content
Alias: two-spaces-between-lines-with-content
Makes sure that the specified line break is added to the ends of lines with content continued on the next line for paragraphs, blockquotes, and list items
Options
Name | Description | List Items | Default Value |
---|---|---|---|
Line Break Indicator |
The line break indicator to use. | : <br/> : <br> : \ : \ |
|
Additional Info
Warning
Do not use with paragraph blank lines. They work differently and will result in unexpected results.
Examples
Make sure two spaces are added to the ends of lines that have content on it and the next line for lists, blockquotes, and paragraphs when the line break indicator is ` `
Before:# Heading 1
First paragraph stays as the first paragraph
- list item 1
- list item 2
Continuation of list item 2
- list item 3
1. Item 1
2. Item 2
Continuation of item 3
3. Item 3
Paragraph for with link [[other file name]].
Continuation *of* the paragraph has `inline code block` __in it__.
Even more continuation
Paragraph lines that end in <br/>
Or lines that end in <br>
Are left swapped
Since they mean the same thing
``` text
Code blocks are ignored
Even with multiple lines
```
Another paragraph here
> Blockquotes are affected
> More content here
Content here
<div>
html content
should be ignored
</div>
Even more content here
# Heading 1
First paragraph stays as the first paragraph
- list item 1
- list item 2
Continuation of list item 2
- list item 3
1. Item 1
2. Item 2
Continuation of item 3
3. Item 3
Paragraph for with link [[other file name]].
Continuation *of* the paragraph has `inline code block` __in it__.
Even more continuation
Paragraph lines that end in
Or lines that end in
Are left swapped
Since they mean the same thing
``` text
Code blocks are ignored
Even with multiple lines
```
Another paragraph here
> Blockquotes are affected
> More content here
Content here
<div>
html content
should be ignored
</div>
Even more content here
Unordered List Style
Alias: unordered-list-style
Makes sure that unordered lists follow the style specified.
Options
Name | Description | List Items | Default Value |
---|---|---|---|
List item style |
The list item style to use in unordered lists | consistent : Makes sure unordered list items use a consistent list item indicator in the file which will be based on the first list item found- : Makes sure unordered list items use - as their indicator* : Makes sure unordered list items use * as their indicator+ : Makes sure unordered list items use + as their indicator |
consistent |
Examples
Unordered lists have their indicator updated to `*` when `List item style = 'consistent'` and `*` is the first unordered list indicator
Before:1. ordered item 1
2. ordered item 2
Checklists should be ignored
- [ ] Checklist item 1
- [x] completed item
* Item 1
- Sublist 1 item 1
- Sublist 1 item 2
- Item 2
+ Sublist 2 item 1
+ Sublist 2 item 2
+ Item 3
* Sublist 3 item 1
* Sublist 3 item 2
1. ordered item 1
2. ordered item 2
Checklists should be ignored
- [ ] Checklist item 1
- [x] completed item
* Item 1
* Sublist 1 item 1
* Sublist 1 item 2
* Item 2
* Sublist 2 item 1
* Sublist 2 item 2
* Item 3
* Sublist 3 item 1
* Sublist 3 item 2
Unordered lists have their indicator updated to `-` when `List item style = '-'`
Before:- Item 1
* Sublist 1 item 1
* Sublist 1 item 2
* Item 2
+ Sublist 2 item 1
+ Sublist 2 item 2
+ Item 3
- Sublist 3 item 1
- Sublist 3 item 2
See that the ordered list is ignored, but its sublist is not
1. Item 1
- Sub item 1
1. Item 2
* Sub item 2
1. Item 3
+ Sub item 3
- Item 1
- Sublist 1 item 1
- Sublist 1 item 2
- Item 2
- Sublist 2 item 1
- Sublist 2 item 2
- Item 3
- Sublist 3 item 1
- Sublist 3 item 2
See that the ordered list is ignored, but its sublist is not
1. Item 1
- Sub item 1
1. Item 2
- Sub item 2
1. Item 3
- Sub item 3
Unordered lists have their indicator updated to `*` when `List item style = '*'`
Before:- Item 1
* Sublist 1 item 1
* Sublist 1 item 2
* Item 2
+ Sublist 2 item 1
+ Sublist 2 item 2
+ Item 3
- Sublist 3 item 1
- Sublist 3 item 2
* Item 1
* Sublist 1 item 1
* Sublist 1 item 2
* Item 2
* Sublist 2 item 1
* Sublist 2 item 2
* Item 3
* Sublist 3 item 1
* Sublist 3 item 2
Unordered list in blockquote has list item indicators set to `+` when `List item style = '-'`
Before:> - Item 1
> + Item 2
> > * Subitem 1
> > + Subitem 2
> > - Sub sub item 1
> > - Subitem 3
> + Item 1
> + Item 2
> > + Subitem 1
> > + Subitem 2
> > + Sub sub item 1
> > + Subitem 3