obsidian-plugin/dylanarmstrong_obsidian-prettier-plugin
1
0
Fork 0
mirror of https://github.com/dylanarmstrong/obsidian-prettier-plugin.git synced 2026-07-22 12:30:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update readme

Browse source
This commit is contained in:
Dylan Armstrong 2025-04-04 09:32:09 +02:00
parent fed450109c
commit 1ed5923f10
No known key found for this signature in database
GPG key ID: C574636C52BA5C5A
1 changed files with 15 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -6,10 +6,22 @@ It uses the built-in settings for tabs and tab spacing so it doesn't require con
# Installation
# History
Unzip the [latest release](https://github.com/dylanarmstrong/obsidian-prettier-plugin/releases/latest) into `.obsidian/plugins` folder of your vault.
Inspired from [https://github.com/alexgavrusev/obsidian-format-with-prettier] with some code taken as well.
# Usage
Format on save is enabled by default, and can be changed under plugin settings.
Additionally, a "Format current file" command is available.
# Customization
This plugin only provides two options to prettier, namely tabWidth and useTabs. They are taken via the Editor settings. Beyond that, there's no customization provided.
# Credits
Significant inspiration taken from [alexgavrusev/obsidian-format-with-prettier](https://github.com/alexgavrusev/obsidian-format-with-prettier).
# License
BSD Zero Clause License, for more details see [License](License.md)
BSD Zero Clause License, for more details see [License](./License.md)