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. All features can be turned on or off individually and have various settings to customize their behavior to your liking.
These are a few exemplary screen captures:
This plugin is compatible with Obsidian v0.15.0 and above. It does not support the legacy editor.
To install community plugins make sure safe mode is turned off in Obsidian's settings.
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
- Download the latest Release from the Releases section of the GitHub Repository
- Extract the plugin folder from the zip to your vault's plugins folder:
<vault>/.obsidian/plugins/
. Note: On some machines the.obsidian
folder may be hidden. On macOS you should be able to pressCommand+Shift+Dot
to show the folder in Finder. - Reload Obsidian
Follow the instructions in the repository of the BRAT plugin and use this repository's URL: https://github.com/davisriedel/obsidian-typewriter-mode
to install the plugin.
This plugin started as a fork of the incredible Typewriter Scroll plugin by 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.
The writing focus was derived from Obsidian Focus Mode.
The repo depends on the latest Obsidian Plugin API.
If you want to contribute to this project or make your own changes, you can do so by following these steps:
- Clone this repo
- Install dependencies with
bun install
- Build with
bun run build
- Create / update test vault with
bun run test-vault
- Open the test vault / reload Obsidian to see changes
You are welcome to open issues and contribute to this project!
I am studying Computer Science at Karlsruhe Institute of Technology (KIT) in Germany. I 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 buymeacoffee.com. I am truly thankful for your support.
See the CHANGELOG.md
file.