Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaellee/stille

🌗 Stille — An Obsidian plugin that helps you focus on your writing, a section at a time.
https://github.com/michaellee/stille

focus obsidian obsidian-md obsidian-plugin writing

Last synced: about 1 month ago
JSON representation

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

Host: GitHub
URL: https://github.com/michaellee/stille
Owner: michaellee
License: mit
Created: 2021-09-01T15:48:30.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2023-02-25T04:37:37.000Z (almost 2 years ago)
Last Synced: 2023-06-16T03:26:01.570Z (over 1 year ago)
Topics: focus, obsidian, obsidian-md, obsidian-plugin, writing
Language: TypeScript
Homepage:
Size: 30.3 KB
Stars: 67
Watchers: 4
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## 🌗 Stille

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

![A screenshot of Stille](https://user-images.githubusercontent.com/1329644/197059096-7a3ad259-6fc3-4471-8f0b-e28c551152eb.png)

[Learn more about Stille.](https://michaelsoolee.com/obsidian-focus-plugin-stille/)

## Install Stille
You can [click on this link](https://obsidian.md/plugins?id=obsidian-stille) and it will open up Obsidian and give you the option to install Stille.

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](https://github.com/junegunn/limelight.vim)

## Show gratitude
If you've benefited from using [Stille for Obsidian](https://obsidian.md/plugins?id=obsidian-stille), please consider [buying me a slice of pizza](https://michaellee.gumroad.com/l/buy-michael-pizza) :pizza:

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

## License

MIT