obsidian-plugin/patrickchiang_obsidian-dialogue-mode
1
0
Fork 0
mirror of https://github.com/patrickchiang/obsidian-dialogue-mode.git synced 2026-07-22 10:20:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
14 commits 1 branch 11 tags 103 KiB
TypeScript 84.3%
JavaScript 13.2%
CSS 2.5%
Find a file
patrickchiang 56f225f17f Updated to 1.1.0
2024-09-29 16:01:29 -07:00
.github/workflows First commit 2024-06-13 16:01:16 -07:00
img First commit 2024-06-13 16:01:16 -07:00
.editorconfig First commit 2024-06-13 16:01:16 -07:00
.eslintignore First commit 2024-06-13 16:01:16 -07:00
.eslintrc First commit 2024-06-13 16:01:16 -07:00
.gitignore First commit 2024-06-13 16:01:16 -07:00
.npmrc First commit 2024-06-13 16:01:16 -07:00
esbuild.config.mjs First commit 2024-06-13 16:01:16 -07:00
LICENSE First commit 2024-06-13 16:01:16 -07:00
main.ts Added another quote type 2024-09-29 03:12:46 -07:00
manifest.json Updated to 1.1.0 2024-09-29 16:01:29 -07:00
package-lock.json First commit 2024-06-13 16:01:16 -07:00
package.json Fixed issue with apostrophe by terminating checks at EOL 2024-07-13 19:21:00 -07:00
README.md Add dialogue text color 2024-06-27 17:36:02 -07:00
styles.css Add dialogue text color 2024-06-27 17:36:02 -07:00
tsconfig.json First commit 2024-06-13 16:01:16 -07:00
version-bump.mjs First commit 2024-06-13 16:01:16 -07:00
versions.json First commit 2024-06-13 16:01:16 -07:00

README.md

Obsidian Dialogue Mode

Obsidian Dialogue Mode is a plugin designed to enhance your writing experience in Obsidian by fading out non-dialogue text, making it easier to focus on the most relevant parts of your writing.

Dialogue mode on

Usage

Dialogue mode is enabled by default.

Toggle Dialogue Mode: Use the command palette (Ctrl+P or Cmd+P) and search for "Toggle dialogue mode" to enable or disable the fade-out effect.

Customizable Fade Intensity: Adjust the fade intensity in the settings tab.

Customizable Dialogue Color: Adjust the color of the text in dialogue.

Installing

  1. Install the Plugin:
    • (Recommended) If installing through Obsidian, go to Settings > Community plugins > Browse and search for "Dialogue Mode".
    • If downloading manually, place the plugin files in your Obsidian plugins folder.
  2. Enable the Plugin: Go to Settings > Community plugins, find "Dialogue Mode" and toggle it on.
  3. Configure Settings: Adjust the plugin settings to your preference by navigating to Settings > Dialogue Mode Settings.

Advanced Customization

For theming, the faded out color (at max intensity) can be changed via this CSS variable:

--dialogue-excluded-text-color

Development

If you want to contribute or modify the plugin, follow these steps:

  • Clone this repo.
  • Make sure your NodeJS is at least v16 (node --version).
  • npm i or yarn to install dependencies.
  • npm run dev to start compilation in watch mode.
  • Feel free to file a pull request with any improvements.