Format with Prettier

approved

by Alex Gavrusev

Format files in your vault using Prettier.

22 stars5,138 downloadsUpdated 3d agoMIT
View on GitHub

obsidian-format-with-prettier

Format files in your Obsidian vault using Prettier

Installation

Unzip the format-with-prettier.zip from the latest release into the .obsidian/plugins folder of your vault.

Note that you might have to reopen your vault for the plugin to show up under "Installed plugins"

Usage

Format on save is enabled by default, and can be changed under plugin settings

Additionally, a "Format current file" command is available

Customization

The plugin fill look for a prettierrc.json (note the lack of . at the start of the file) in the root folder of your vault. In it, you can configure Prettier as you normally would

Formatting the entire vault at once

Use the Prettier CLI:

$ cd YOUR_VAULT_FOLDER
$ echo '**/.obsidian' > .prettierignore
$ npx prettier . --write --config prettierrc.json

License

MIT © Aliaksandr Haurusiou.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.