Skip to content

harmtemolder/obsidian-ink

Repository files navigation

Ink

A monochrome color scheme for Obsidian, optimized for e-ink (or e-paper) screens.

No dark theme is included, because that would not make sense on e-ink.

Screenshot of the Ink theme in Obsidian

How to install

Find this theme in the Obsidian's community themes browser under Settings > Appearance > Themes. If that doesn't work, double-check if you are running the latest version of Obsidian.

How to develop

Make changes in the scss files and compile theme.scss into theme.css using something like dart-sass:

sass theme.scss theme.css

Add --watch if you want.

I use the .vscode/tasks.json to compile with ctrl+shift+B in VSCodium.

How to release

A GitHub workflow runs to build a release when a tag is pushed to the repository, as described here. To trigger that:

  1. Update the version number (without a v) in manifest.json.
  2. Create a tag (with v) with a message (without v) that matches the version in the manifest.json file and push it to GitHub:
git tag v0.1.1 --message=0.1.1
git push origin --tags
  1. Check the result on https://github.com/harmtemolder/obsidian-ink/releases and publish the draft release.

About

A monochrome color scheme for Obsidian, optimized for e-ink screens.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages