https://github.com/patrickchiang/obsidian-dialogue-mode

https://github.com/patrickchiang/obsidian-dialogue-mode

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/patrickchiang/obsidian-dialogue-mode
• Owner: patrickchiang
• License: mit
• Created: 2024-06-13T22:58:04.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-14T02:21:17.000Z (6 months ago)
• Last Synced: 2024-08-13T07:16:32.080Z (5 months ago)
• Language: TypeScript
• Size: 76.2 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - patrickchiang/obsidian-dialogue-mode - (TypeScript)

README

        
# 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](img/dialogue.png)

## 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.