README file from
GithubTypewriter Mode for Obsidian
 |
 |
 |
 |
 |
Typewriter Mode turns Obsidian 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
- Download the latest release from GitHub: https://github.com/davisriedel/obsidian-typewriter-mode/releases
- Extract the plugin folder from the zip to your vault's plugins folder:
<vault>/.obsidian/plugins/. Note: On some machines, the.obsidianfolder may be hidden. On macOS, you should be able to pressCommand+Shift+Dotto show the folder in Finder. - Force reload Obsidian (Ctrl/Cmd+P → "Reload app without saving")
Beta Versions With BRAT
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 beta versions of the plugin.
Disclosures
This plugin makes a single network request to github.com in order to fetch release notes when a new version of the plugin is installed. You can disable this, by disabling the update notice in the plugin's settings. No other network requests are made.
Acknowledgements
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 by artisticat1.
The writing focus was derived from Obsidian Focus Mode by ryanpcmcquen.
The restore cursor position feature was derived from Remember Cursor Position by dy-sh.
The hemingway mode feature was derived from Obsidian Hemingway Mode by 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.
Changelog
See the CHANGELOG.md file.
Contribute
You are welcome to open issues and contribute to this project!
See the DEVELOPMENT.md file for instructions.
License
The plugin is licensed under the MIT license. See LICENSE.