Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/crashmoney/obsidian-typewriter

Typewriter is an Obsidian theme designed for a focused writing experience.
https://github.com/crashmoney/obsidian-typewriter

obsidian-md obsidian-theme

Last synced: about 1 month ago
JSON representation

Typewriter is an Obsidian theme designed for a focused writing experience.

Awesome Lists containing this project

README 

        
# Obsidian Typewriter



Typewriter is an [Obsidian](https://www.obsidian.md) October-winning theme designed for a focused writing experience.



![cover](cover.jpg)



## Features



- Careful choice in fonts; monospace in the editor and semi-proportional in preview and UI

- Fonts have been base64 encoded, meaning you don't need to install them to use Typewriter

  - This means that the fonts used here are available on mobile

- Markdown formatting symbols are faded and shrunk, letting you focus on words instead

- Vim cursor support

- Long titles in the file explorer will soft-wrap

  - Useful for mobile and small displays

- Seamless embeds, without file titles

- Cool dark mode and warm light mode

- Compatibility with community plugins (see [Plugin Compatibility](#plugin-compatibility))

- Compatibility with Obsidian Hub

- Highlight on the active line for focus

  - Currently unavailable in v2.0.0 (Obsidian version 0.16.0 onwards)



## Recommended Plugins



- [Typewriter Scroll by @death_au](https://github.com/deathau/cm-typewriter-scroll-obsidian) for the full typewriter experience

  - This plugin comes also with a focus mode, which dims every line except the active one

- [Click Clack by @Acylation](https://github.com/Acylation/obsidian-click-clack) (still in beta) for typewriter sounds

- [Style Settings by @mgmeyers](https://github.com/mgmeyers/obsidian-style-settings) for easy customization



## Plugin Compatibility



*This list is non-exhaustive; other plugins I haven't tested yet may work. The plugins on this list are plugins I've tested or added specific support for.*



- [Calendar by @liamcain](https://github.com/liamcain/obsidian-calendar-plugin)

- [Kanban by @mgmeyers](https://github.com/mgmeyers/obsidian-kanban)

- [Sliding Panes (Andy's Mode) by @death_au](https://github.com/deathau/sliding-panes-obsidian)

- [Tag Wrangler by @pjeby](https://github.com/pjeby/tag-wrangler)

- [Typewriter Scroll by @death_au](https://github.com/deathau/cm-typewriter-scroll-obsidian)

- [Better Word Count by @lukeleppan](https://github.com/lukeleppan/better-word-count)

- [Day Planner by @lynchjames](https://github.com/lynchjames/obsidian-day-planner)

- [Workbench by @ryanjamurphy](https://github.com/ryanjamurphy/workbench-obsidian)

- [Citations by @hans](https://github.com/hans/obsidian-citation-plugin)

- [Journey by @akaalias](https://github.com/akaalias/obsidian-journey-plugin)

- [Banners by @noatpad](https://github.com/noatpad/obsidian-banners)

- [Dataview by @blacksmithgu](https://github.com/blacksmithgu/obsidian-dataview)

- [Style Settings by @mgmeyers](https://github.com/mgmeyers/obsidian-style-settings)

- [Obsidian TODO by @larslockefeer](https://github.com/larslockefeer/obsidian-plugin-todo)



## Development



This theme is currently under development. [Issues](https://github.com/crashmoney/obsidian-typewriter/issues) and [pull requests](https://github.com/crashmoney/obsidian-typewrtier/pulls) are welcome.



Please see [Releases](https://github.com/crashmoney/obsidian-typewriter/releases) for changes between updates.



## Installation



### Recommended (Obsidian Theme Manager)



1. Open Settings

2. Navigate to Appearance

3. Press the 'Manage' button

4. Search for Typewriter and press 'Install'



### Manual



You can also manually install this theme.



For Obsidian version 0.16.0/1.0.0 and above:



1. Download `theme.css` and `manifest.json`

2. In your vault's hidden theme directory (`.obsidian/themes/`), create a `Typewriter/` directory

3. Move `theme.css` and `manifest.json` into the `.obsidian/themes/Typewriter` folder



For Obsidian version 0.15.9 and below:



1. Download `obsidian.css`

    - Please note that `obsidian.css` has been deprecated. Development will focus more on `theme.css`.

2. Rename the file to `Typewriter.css`

3. Move the file to your vault's theme directory

    - Navigate to your vault's hidden `.obsidian/themes` folder

    - Place `Typewriter.css` inside that folder



## Credits



Inspiration and/or some code were taken from the following:



- [Minimal by @kepano](https://github.com/kepano/obsidian-minimal)

- [Yin and Yang by @chetachiezikeuzor](https://github.com/chetachiezikeuzor/Yin-and-Yang-Theme)

- [Deep Work by @nikbrunner](https://github.com/nikbrunner/obsidian-deep-work-theme)

- the Scrivener theme A Midsummer Night for the colors behind Typewriter's dark mode

- Solarized Light for the colors behind Typewriter's light mode



### Fonts



This theme uses the fonts iA Writer Mono V, iA Writer Quattro S and JetBrains Mono. These fonts have been base64 encoded into the theme CSS, meaning that you don't have to install them and that they are available on mobile. If you want to, however, the links are below:



- [iA Writer Fonts (GitHub)](https://github.com/iaolo/iA-Fonts)

- [JetBrains Mono (Google Fonts)](https://fonts.google.com/specimen/JetBrains+Mono#standard-styles)