Zen Mode

by paperbenni
5
4
3
2
1
Score: 55/100

Description

Category: Customization & UI

The Zen Mode plugin transforms Obsidian into a distraction-free environment, perfect for reading, presentations, or focused writing. By hiding most of the UI elements, it maximizes the space available for your content, whether on mobile or desktop. Zen Mode ensures a clean, minimalist interface, leaving only the essential view of your document. On mobile, it significantly improves PDF viewing, utilizing nearly the entire screen, while on desktop, it provides a quick toggle between editing and viewing modes. This plugin also integrates seamlessly with themes through its zenmode-active class, enhancing compatibility for a truly immersive experience.

Reviews

No reviews yet.

Stats

17
stars
6,510
downloads
5
forks
568
days
29
days
29
days
11
total PRs
1
open PRs
1
closed PRs
9
merged PRs
13
total issues
2
open issues
11
closed issues
41
commits

Latest Version

a month ago

Changelog

README file from

Github

Overview

An Obsidian Zen-Mode pluigin based on the Hider plugin.

This plugin enables you to hide most Obsidian UI to be able to focus on the content.

Changes in most recent version

  • Top bar is draggable in Zen mode
  • Added device-dependent "exit Zen mode" button option
  • Added "Full screen" option
  • Added "Hide properties" option
  • Added "Hide inline title" option
  • Added top/bottom padding options
  • Added focused file option

Why

Obsidian is by default unfit for content consumption or presentations. On mobile, viewing a PDF results in less than 40% of the screen being used for the PDF.

mobile_nozen

Zen Mode hides all UI Elements except the current text file or document, all that remains is a single button to restore all UI

mobile_zen

On desktop the problem is less severe, but there is still no way to quickly switch from an editing friendly experience to a viewing friendly experience. In addition to hiding all UI, zen mode also collapses and restores the side bars when being toggled.

desktop_nozen desktop_zen

Making your theme compatible with ZenMode

ZenMode injects the zenmode-active class on the body element when zen mode is active.

Development

  • pnpm install - Install dependencies
  • pnpm dev - Start development build in watch mode
  • pnpm build - Build production version
  • pnpm lint / pnpm lint:fix - Run linting
  • pnpm version minor/major/patch - Bump version

TODO

refactor CSS

  • lots of duplicate code
  • CSS formatter config?

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
Icon Shortcodes
5 years ago by AidenLx
Obsidian Plugin: Insert emoji and custom icons with shortcodes
Ninja Cursor
4 years ago by vorotamoroz
Emoji Magic
3 years ago by simplgy
Makes it easier to add emojis using an improved keyword search
Soomda
3 years ago by Michael Lee
🙈 Soomda — An Obsidian plugin that lets you quickly hide your sidebars.
Auto Hide Cursor
3 years ago by Mo Ismat
A simple plugin for https://obsidian.md
Blur
3 years ago by @gapmiss
A plugin for creating obfuscated blocks of text in Obsidian.md
Background Image
3 years ago by shmolf
Editor Width Slider
3 years ago by @MugishoMp
With this plugin you can set the line width of the editor in obsidian.
CSS Editor
3 years ago by Zachatoo
Edit CSS snippets in Obsidian.
Tokei
3 years ago by HiroMike
A simple clock for Obsidian
Auto Reading Mode
3 years ago by Kelvin Cao
Canvas Card Background Remover
2 years ago by luxmargos
This Obsidian plugin allows you to make the background of cards transparent in the Canvas for specific embed types, including Image (png), Canvas, and even Markdown.
Additional Icons
2 years ago by Matthew Turk
Add additional iconsets to Obsidian
Full Screen Toggle
2 years ago by Donkey Pacific
Fullscreen toggle plugin across all platforms for Obsidian.
Font Size Adjuster
2 years ago by Ryota Ushio
An Obsidian.md plugin to adjust font size via commands.
cursor-goaway
2 years ago by Xuer
make cursor goaway after open a text file
Beautitab
2 years ago by Andrew McGivery
A plugin for Obsidian.MD that creates a customizable new tab view with beautiful backgrounds, quotes, search, and more.
Status Bar Organizer
2 years ago by Kacper Darowski
Arrange and hide status bar elements.
Tag Formatter
2 years ago by snsvrno
Configurable Obsidian plugin that hides parent tags.
Command Block List
2 years ago by Ryota Ushio
Hide unwanted commands from the command palette in Obsidian.
Color cycler
2 years ago by Taylor Brennan
Plugin for Obsidian to dynamically change the accent color
Fontsource
2 years ago by Ayuhito
A plugin to load custom fonts from Fontsource into Obsidian.
Close Window When Empty
2 years ago by Taylor Jadin
Node Auto Resize
2 years ago by Boninall
Shrink pinned tabs
2 years ago by Nicolas Lœuillet
Obsidian plugin to shrink pinned tabs in order to save screen space
Iconic
2 years ago by Holo
Customize your icons and colors directly from the Obsidian UI, including tabs, files & folders, bookmarks, tags, properties, and ribbon commands.
Hider
6 years ago by @kepano
Hide Obsidian UI elements such as tooltips, status, titlebar and more
Focus Mode
5 years ago by ryanpcmcquen
Add focus mode to Obsidian.
Homepage
5 years ago by mirnovov
An Obsidian plugin that opens a specified note, canvas, or workspace on startup, instead of the most recent one.
File Explorer Markdown Titles
5 years ago by Dylan Elliott
Obsidian Plugin that adds the the markdown title within your notes to the file explorer
Theme Controller
a year ago by Binaris
Set when and how the themes will be displayed
Backgroundset
a year ago by daonali
similar as vscode background
Context Command Hider
a year ago by Mara-Li
This plugin allows you to hide every command from the Obsidian's right-click context menu.
Explorer Colors
a year ago by Scott Van der Zwet
Set cascading colors for files and folders in Obsidian.
Hide Commands in Menu
a year ago by bomian98
Obsidian Plugin, hide different commands in different menus.
Wheel Tab Switcher
a year ago by 22-2
Switch between Obsidian Tabs using your mouse wheel when hovering over tab headers.
Collapsible Code Blocks
a year ago by Bradley Wyatt
Obsidian Plugin that makes code blocks collapsible in reading and edit view as well as enabling scroll-able code blocks.
Theme by Folder
a year ago by Jinmu Go
Automatically switch Obsidian themes based on the folder of the opened note
Hide Traffic Lights
3 months ago by Ben Phillips
Hides macOS traffic light buttons for a distraction-free experience. Hover over the top-left corner to reveal them.