obsidian-css-editor
obsidian-css-editor copied to clipboard
Edit CSS snippets in Obsidian.
CSS Editor
This plugin allows you to edit CSS files in the .obsidian/snippets/
directory.
Features
- Create, edit, and delete CSS snippets
- Syntax highlighting and code completion
- Works on desktop and mobile
- Basic VIM support
Installation
Recommended to install from the Obsidian community store.
You can manually install this using the BRAT Obsidian plugin. Generic installation instructions are available on that plugin's documentation.
Commands
Create CSS Snippet
Opens a prompt to create a CSS snippet in your .obsidian/snippets/
directory. Upon creation, show editor to edit that CSS file.
Open Quick Switcher
Opens a suggestion modal to create, edit, or delete a CSS snippet. Has similar functionality to the core quick switcher where holding down a secondary key will modify the action that will take place.
- Press Enter to open the selected CSS snippet, or if no suggestions are available, create a new CSS snippet.
- Press ⌘Enter to open the selected CSS snippet in a new tab.
- Press ShiftEnter to create a new CSS snippet.
- Press Tab to toggle the enable/disable state of the selected CSS snippet.
- Press ⌘Delete to delete the selected CSS snippet.
Delete Current CSS Snippet
Deletes the currently active CSS snippet file. Only available when viewing a CSS snippet file.
Toggle the enabled/disabled State of the Current CSS Snippet
If the currently active CSS snippet file is enabled then disable it, and vice versa. Only available when viewing a CSS snippet file. Note that you can also toggle this state directly from the quick switcher using the Tab key.
Contributing
Releasing
Releasing a new version involves the following steps:
- Update the version in the
package.json
. - Run
npm run version
to update the versions in other related files. - Commit the changes.
- Add a tag matching the version from step 1.
- Push the changes and tags. This will trigger a GitHub action to create a release.
Running tests
Tests are run within Obsidian, they cannot be run in a CLI. Running npm run test
will output a plugin that has one command to run the tests. You can then run that command in Obsidian and the tests results will be output to the console in Obsidian.