obsidian-plugin/al3xw_force-read-mode
1
0
Fork 0
mirror of https://github.com/al3xw/force-read-mode.git synced 2026-07-22 11:00:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
13 commits 1 branch 7 tags 106 KiB
TypeScript 80.8%
JavaScript 17.6%
CSS 1.6%
Find a file
al3x c85133cc5d 1.0.5 adjusted imports
2026-06-12 22:30:12 +02:00
src 1.0.5 adjusted imports 2026-06-12 22:30:12 +02:00
.editorconfig Initial commit 2024-10-09 22:39:19 +02:00
.eslintignore Initial commit 2024-10-09 22:39:19 +02:00
.eslintrc Initial commit 2024-10-09 22:39:19 +02:00
.gitignore Initial commit 2024-10-09 22:39:19 +02:00
.npmrc Initial commit 2024-10-09 22:39:19 +02:00
esbuild.config.mjs Initial commit 2024-10-09 22:39:19 +02:00
jest.config.js Add Jest test infrastructure 2026-06-02 22:12:38 -07:00
LICENSE Create LICENSE 2024-10-09 22:40:05 +02:00
main.ts 1.0.5 adjusted imports 2026-06-12 22:30:12 +02:00
manifest.json 1.0.5 adjusted imports 2026-06-12 22:30:12 +02:00
package-lock.json 1.0.5 adjusted imports 2026-06-12 22:30:12 +02:00
package.json 1.0.5 adjusted imports 2026-06-12 22:30:12 +02:00
README.md added micromatch 2025-12-29 17:22:48 +01:00
styles.css Initial commit 2024-10-09 22:39:19 +02:00
tsconfig.json Initial commit 2024-10-09 22:39:19 +02:00
tsconfig.test.json Add Jest test infrastructure 2026-06-02 22:12:38 -07:00
version-bump.mjs Initial commit 2024-10-09 22:39:19 +02:00
versions.json Initial commit 2024-10-09 22:39:19 +02:00

README.md

Force Read Mode

Force Read Mode is a simple Obsidian plugin that ensures all Markdown files within specified paths are always opened in read (preview) mode. It’s useful when you want to prevent accidental edits or enforce a read-only experience for certain files.

Features

  • Automatically forces read mode when opening Markdown files from specified folders.
  • Supports multiple folder patterns.
  • Uses powerful micromatch glob syntax.
  • Simple and lightweight.
  • Quickly enable or disable via the Command Palette.
  • No impact on files outside the configured folders.

How It Works

  • When a Markdown file is opened, the plugin checks its path.
  • If the path matches a configured pattern, the file opens in read mode.
  • This happens every time the file is opened.
  • You can temporarily disable this behavior using a command.

How to Use

  1. Go to Settings → Community Plugins → Browse and install the Force Read Mode plugin.
  2. Enable the plugin from Settings → Community Plugins.
  3. Open Settings → Force Read Mode to configure:
    • Add a pattern for files you want to open in read mode (one pattern per line).
    • Patterns use micromatch syntax.
    • Examples:
      • Notes/** — all files under the Notes folder (any depth).
      • Projects/*/*.md — Markdown files directly inside a subfolder of Projects.
      • **/Readme.md — all Readme.md files.
  4. Use the Command Palette (Ctrl+P or Cmd+P) to toggle the plugin on or off with Force Read Mode: Enable or Force Read Mode: Disable.

Development

To contribute to or modify this plugin:

  1. Clone the repository.
  2. Install dependencies using npm install.
  3. Build the plugin with npm run build.
  4. Load the plugin into Obsidian for testing.
  5. Open a pull request with your changes.