https://github.com/davisriedel/obsidian-typewriter-mode
Typewriter Mode is a plugin that adds typewriter scrolling (current line stays at a fixed position on the screen), a highlight for the current line, dimming of unfocused paragraphs and more to Obsidian.
https://github.com/davisriedel/obsidian-typewriter-mode
markdown obsidian plugin typewriter
Last synced: 2 months ago
JSON representation
Typewriter Mode is a plugin that adds typewriter scrolling (current line stays at a fixed position on the screen), a highlight for the current line, dimming of unfocused paragraphs and more to Obsidian.
- Host: GitHub
- URL: https://github.com/davisriedel/obsidian-typewriter-mode
- Owner: davisriedel
- License: mit
- Created: 2023-04-03T08:42:43.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-01T20:04:52.000Z (3 months ago)
- Last Synced: 2026-03-01T21:57:54.998Z (3 months ago)
- Topics: markdown, obsidian, plugin, typewriter
- Language: TypeScript
- Homepage:
- Size: 35.6 MB
- Stars: 186
- Watchers: 3
- Forks: 6
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Typewriter Mode for Obsidian
| | | | | |
| -- | -- | -- | -- | -- |
|[](https://github.com/davisriedel/obsidian-typewriter-mode)|[](https://obsidian.md/)|[](https://github.com/davisriedel/obsidian-typewriter-mode/releases)|[](https://www.buymeacoffee.com/davis.riedel)|[](https://github.com/sponsors/davisriedel)|
Typewriter Mode turns [Obsidian](https://obsidian.md) into a distraction-free writing environment.
- Typewriter scrolling (current line stays at a fixed position on the screen)
- Current line highlighting
- Configurable number of lines kept above and below the cursor
- Dimming of unfocused paragraphs / sentences
- Fullscreen writing focus
- Limit line length
- Restore cursor position when opening files
- Hemingway mode (disables editing previous text — write forwards only)
## Installation
To install community plugins, make sure _Restricted mode_ is turned off in Obsidian's settings.
### Obsidian
You can install this plugin within Obsidian by doing the following:
- Go to Settings > Community Plugins > Browse
- Search for “Typewriter Mode”
- Click Install
- Click Enable
### Manual
1. Download the latest release from GitHub: [https://github.com/davisriedel/obsidian-typewriter-mode/releases](https://github.com/davisriedel/obsidian-typewriter-mode/releases)
2. Extract the plugin folder from the zip to your vault's plugins folder: `/.obsidian/plugins/`. _Note: On some machines, the `.obsidian` folder may be hidden. On macOS, you should be able to press `Command+Shift+Dot` to show the folder in Finder._
3. Force reload Obsidian (Ctrl/Cmd+P → "Reload app without saving")
### Beta Versions With BRAT
Follow the instructions in the repository of the [BRAT plugin](https://github.com/TfTHacker/obsidian42-brat#Quick-Guide-for-using-BRAT) and use this repository's URL: `https://github.com/davisriedel/obsidian-typewriter-mode` to install **beta versions** of the plugin.
## Acknowledgements
This plugin started as a fork of the incredible [Typewriter Scroll](https://github.com/deathau/cm-typewriter-scroll-obsidian) plugin by [deathau](https://github.com/deathau). It was turned into a separate plugin because many new features were added, breaking changes were introduced, and the code was completely restructured to make it more extensible.
The sentence highlighting was derived from [Focus Active Sentence](https://github.com/artisticat1/focus-active-sentence) by [artisticat1](https://github.com/artisticat1).
The writing focus was derived from [Obsidian Focus Mode](https://github.com/ryanpcmcquen/obsidian-focus-mode) by [ryanpcmcquen](https://github.com/ryanpcmcquen).
The restore cursor position feature was derived from [Remember Cursor Position](https://github.com/dy-sh/obsidian-remember-cursor-position) by [dy-sh](https://github.com/dy-sh).
The hemingway mode feature was derived from [Obsidian Hemingway
Mode](https://github.com/jobedom/obsidian-hemingway-mode) by [jobedom](https://github.com/jobedom).
Many thanks to the developers of these fantastic plugins. Please also consider supporting them.
## Support this project
I am a student at the University of Tübingen and develop this plugin in my spare time. If you wish to support me and the continuous development of this plugin, you can donate via GitHub Sponsors or Buy Me a Coffee. Any support is greatly appreciated.
[](https://www.buymeacoffee.com/davis.riedel)
[](https://github.com/sponsors/davisriedel)
## Changelog
See the [`CHANGELOG.md`](CHANGELOG.md) file.
## Contribute
**You are welcome to open issues and contribute to this project!**
See the [`DEVELOPMENT.md`](DEVELOPMENT.md) file for instructions.
## License
The plugin is licensed under the MIT license. See [`LICENSE`](LICENSE).