README.md

Obsidian Linter

This Obsidian plugin formats and styles your notes with a focus on configurability and extensibility. Rules can be toggled and configured in the settings. The main documentation on rules and other things are located on the wiki. Below is a quick run down of some reference links to the rules that exist and how to install the Linter.

Rules

Documentation for all rules can be found on the wiki. The docs are updated before the plugin is released, so they may not be completely accurate.

Each rule is its own set of logic and is designed to be run independently. This means that enabling certain rules together could cause undesired results. One such case would be using "Paragraph blank lines" with "Two Spaces Between Lines with Content". These two rules have some overlap in what they target to change which results in undesired or unexpected results since together they work differently than if they were run by themselves.

YAML rules

• add-blank-line-after-yaml
• dedupe-yaml-array-values
• escape-yaml-special-characters
• force-yaml-escape
• format-tags-in-yaml
• format-yaml-array
• insert-yaml-attributes
• move-tags-to-yaml
• remove-yaml-keys
• sort-yaml-array-values
• yaml-key-sort
• yaml-timestamp
• yaml-title
• yaml-title-alias

Heading rules

• capitalize-headings
• file-name-heading
• header-increment
• headings-start-line
• remove-trailing-punctuation-in-heading

Footnote rules

• footnote-after-punctuation
• move-footnotes-to-the-bottom
• re-index-footnotes

Content rules

• auto-correct-common-misspellings
• blockquote-style
• convert-bullet-list-markers
• default-language-for-code-fences
• emphasis-style
• no-bare-urls
• ordered-list-style
• proper-ellipsis
• quote-style
• remove-consecutive-list-markers
• remove-empty-list-markers
• remove-hyphenated-line-breaks
• remove-multiple-spaces
• strong-style
• two-spaces-between-lines-with-content
• unordered-list-style

Spacing rules

• compact-yaml
• consecutive-blank-lines
• convert-spaces-to-tabs
• empty-line-around-blockquotes
• empty-line-around-code-fences
• empty-line-around-horizontal-rules
• empty-line-around-math-blocks
• empty-line-around-tables
• heading-blank-lines
• line-break-at-document-end
• move-math-block-indicators-to-their-own-line
• paragraph-blank-lines
• remove-empty-lines-between-list-markers-and-checklists
• remove-link-spacing
• remove-space-around-characters
• remove-space-before-or-after-characters
• space-after-list-markers
• space-between-chinese-japanese-or-korean-and-english-or-numbers
• trailing-spaces

Paste rules

• add-blockquote-indentation-on-paste
• prevent-double-checklist-indicator-on-paste
• prevent-double-list-item-indicator-on-paste
• proper-ellipsis-on-paste
• remove-hyphens-on-paste
• remove-leading-or-trailing-whitespace-on-paste
• remove-leftover-footnotes-from-quote-on-paste
• remove-multiple-blank-lines-on-paste

Installing

As of version 0.9.7 of Obsidian, this plugin is available to be installed directly from within the app. The plugin can be found in the Community Plugins directory which can be accessed from the Settings pane under Third Party Plugins. The plugin is called Linter.

Manual installation

1. Download the latest release
2. Extract the obsidian-linter folder from the zip to your vault's plugins folder: <vault>/.obsidian/plugins/
   Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder.
3. Reload Obsidian
4. If prompted about Safe Mode, you can disable safe mode and enable the plugin.

How You Can Help

Contributions are welcome and appreciated. You can help in any of the following ways:

No repo setup required:

• Reporting a bug
• Requesting a feature
• Suggesting documentation

Varying repo and development setup required:

• Updating or adding documentation
• Translating the plugin into a new language
• Fixing a bug
• Adding a new rule