Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.1 KB

README.md

File metadata and controls

46 lines (29 loc) · 2.1 KB
Raw

🌗 Stille

An Obsidian plugin that helps you focus on your writing, a section at a time.

A screenshot of Stille

Learn more about Stille.

Install Stille

You can click on this link and it will open up Obsidian and give you the option to install Stille.

Or

You can install Stille from within Obsidian by going to Settings > Community plugins and clicking the Browse button under Community plugins. Then search for Stille in the search field.

Getting started

  • Once Stille is installed, make sure the plugin is activated under Community plugins > Installed plugins in Settings
  • Once activated, you'll see a new moon-shaped icon in the left hand ribbon. This is the toggle to turn Stille on and off. You'll also see in the bottom status bar, a status for Stille that indicates whether it's on or off.
  • Stille also comes with a hotkey to toggle it on or off, command + shift + s on macOS or control + shift + s on Windows.

To develop

  • Clone repository
  • Run npm i to install dependencies
  • Run npm run dev

To install from repo

  • Follow steps above in "To develop" section
  • Instead of running npm run dev, you want to run npm run build
  • Create a folder in your vault's .obsidian/plugins folder called "stille"
  • Then copy and paste the main.js, manifest.json and styles.css files into the new stille folder
  • Activate community plugins by turning off safe mode under settings and you should now see the option to turn on Stille

Acknowledgement

Limelight by Junegunn Choi

Show gratitude

If you've benefited from using Stille for Obsidian, please consider buying me a slice of pizza 🍕

It keeps me motivated to continue to support and improve Stille.

License

MIT