Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 4.51 KB

README.md

File metadata and controls

80 lines (50 loc) · 4.51 KB

Typewriter Mode for Obsidian

Typewriter Mode is plugin that adds several features to turn Obsidian into a typewriter-like, distraction-free writing environment, including:

  • Typewriter scrolling (current line stays at a fixed position on the screen)
  • Highlighting the current line
  • Keeping a set number of lines above and below the cursor
  • Dimming unfocused paragraphs / sentences
  • Fullscreen writing focus
  • Limit line length to set number of characters
  • Restore the cursor's position when opening files

Compatibility

This plugin is compatible with Obsidian v0.15.0 and above. It does not support the legacy editor.

Installation

To install community plugins, make sure safe 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
  2. 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 press Command+Shift+Dot to show the folder in Finder.
  3. Force reload Obsidian

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.

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.

Many thanks to the developers of these fantastic plugins. Please also consider supporting them.

Support 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 Buy Me a Coffee. I am truly thankful for your support.

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.