mirror of
https://github.com/patruusbarba/ObsidianSpoilerPlugin.git
synced 2026-07-22 07:48:59 +00:00
Fix spoiler-format docs to match fence-free output
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
a9d1c7120b
commit
6e88ebdbf2
1 changed files with 12 additions and 8 deletions
20
README.md
20
README.md
|
|
@ -16,18 +16,22 @@ it again on a spoiler and it gets 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:
|
||||
The plugin wraps your selection in a collapsible `spoiler` callout. Each line of
|
||||
the selection becomes a callout line, so any markdown inside it (headings, lists,
|
||||
code blocks, …) is preserved:
|
||||
|
||||
```markdown
|
||||
> [!spoiler]- crypto key
|
||||
>```
|
||||
>super_secret_key
|
||||
>```
|
||||
> [!spoiler]-
|
||||
> super_secret_key
|
||||
```
|
||||
|
||||
In reading view this renders as a collapsed callout titled *crypto key*; click it
|
||||
to reveal the hidden contents.
|
||||
In reading view this renders as a collapsed callout; click it to reveal the
|
||||
hidden contents. The `-` after `[!spoiler]` is what makes the callout start
|
||||
collapsed.
|
||||
|
||||
Unwrapping is the exact inverse — it removes the callout markers and returns
|
||||
your original text untouched, so wrapping and then unwrapping a selection always
|
||||
gives back exactly what you started with.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue