obsidian-plugin/patruusbarba_ObsidianSpoilerPlugin
1
0
Fork 0
mirror of https://github.com/patruusbarba/ObsidianSpoilerPlugin.git synced 2026-07-22 07:48:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
3 commits 1 branch 3 tags 217 KiB
TypeScript 65.1%
JavaScript 34.9%
Find a file
root 449f050f69 Implement spoiler plugin: ribbon button to wrap/unwrap selection 
Adds an Obsidian plugin that places a button on the left ribbon. Selecting
text and pressing it wraps the selection in a collapsible `> [!spoiler]-`
callout; pressing it on an existing spoiler unwraps it back to plain text.
Also exposed as the "Toggle spoiler on selection" command.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 19:42:52 +00:00
.gitignore Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
esbuild.config.mjs Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
main.ts Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
manifest.json Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
package.json Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
README.md Fill in README 2026-06-15 19:35:37 +00:00
tsconfig.json Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
version-bump.mjs Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00
versions.json Implement spoiler plugin: ribbon button to wrap/unwrap selection 2026-06-15 19:42:52 +00:00

README.md

Obsidian Spoiler Plugin

An Obsidian plugin that lets you hide and reveal sensitive text in your notes with a single click. Select some text, press the ribbon button, and the selection is wrapped in a collapsible spoiler callout. Press it again on a spoiler and it gets unwrapped back to plain text.

Features

  • Adds a button to the left ribbon (near Open daily note).
  • Wraps the currently selected text in a collapsible spoiler callout.
  • Toggling: if the selection already is a spoiler, it is unwrapped back to plain text.

Spoiler format

The plugin wraps your selection in a collapsible callout with a fenced code block, so the content stays hidden until you expand it:

> [!spoiler]- crypto key
>```
>super_secret_key
>```

In reading view this renders as a collapsed callout titled crypto key; click it to reveal the hidden contents.

Usage

  1. Open a note and select the text you want to hide.
  2. Click the spoiler button in the left ribbon.
  3. The selected text is replaced with a spoiler callout.
  4. To reveal it permanently, select the spoiler and click the button again to unwrap it.

Installation

Manual

  1. Build the plugin (see below) or download a release.
  2. Copy main.js, manifest.json, and styles.css (if present) into your vault at <vault>/.obsidian/plugins/obsidian-spoiler-plugin/.
  3. Reload Obsidian and enable Spoiler Plugin in Settings → Community plugins.

Building from source

npm install
npm run build

License

MIT