A plugin for Obsidian which shows whitespace in the editor.
Utilizes code from cm-show-invisibles by coderaiser
Custom plugins are only available for Obsidian v0.9.7+.
The current API of this repo targets Obsidian v0.10.0.
This is all very expermental at the moment, so parts might not work, etc.
There are certain css classes, etc that can interfere with it and make the whitespace characters stand out more.
Check out the styles.css in the release to see what styles are added to be customized.
You can override the following CSS variables in your custom CSS to use different characters if you wish.
--spaceChar
--trailingSpaceChar
--singleSpaceChar
--tabChar
--newlineChar
--strictLineBreakChar
From Obsidian v0.9.8, you can activate this plugin within Obsidian by doing the following:
You can follow the same procedure to update the plugin
cm-show-whitespace-obsidian
folder from the zip to your vault's plugins folder: <vault>/.obsidian/plugins/
.obsidian
folder may be hidden. On MacOS you should be able to press Command+Shift+Dot
to show the folder in Finder.This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API in Typescript Definition format, which contains TSDoc comments describing what it does.
Note: The Obsidian API is still in early alpha and is subject to change at any time!
If you want to contribute to development and/or just customize it with your own tweaks, you can do the following:
npm i
or yarn
to install dependenciesnpm run build
to compile.manifest.json
, main.js
and styles.css
to a subfolder of your plugins
folder (e.g, <vault>/.obsidian/plugins/cm-show-whitespace-obsidian/
)Alternately, you can clone the repo directly into your plugins folder and once
dependencies are installed use npm run dev
to start compilation in watch mode.
You may have to reload obsidian (ctrl+R
) to see changes.
Huh? This is an open-source plugin I made for fun. It's completely free. However, if you absolutely have to send me money because you like it that much, feel free to throw some coins in my hat via PayPal or sponsor me via GitHub Sponsors
--spaceChar
, --tab-char
and --newlineChar
This is my first real release utilizing automation 🤞
styling fixes to center space dots and adjust colours
Initial Release!
No fancy settings or anything, just turn it on or off through the third party plugin settings