0
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-08-06 09:44:06 +08:00
discourse/plugins/discourse-details/README.md
Martin Brennan 1620a74bd4
DEV: Update discourse-details description and README (#40786)
The plugin metadata and README described it as an "HTML5.1 Details
polyfill" with an IE9 note, which is long obsolete now that
`<details>/<summary>` is universally supported. The plugin is really the
implementation of the [details] BBCode feature (markdown rule, composer
button, rich editor support, email/excerpt rendering).

Update the about line and README to describe what the plugin actually
does, and drop the stale standalone-repo installation instructions since
it ships bundled with core.
2026-06-12 07:59:18 +10:00

24 lines
703 B
Markdown
Vendored

### discourse-details
Adds collapsible `[details]` sections to posts in [Discourse](https://www.discourse.org).
The plugin registers the `[details]` BBCode tag, a composer toolbar button and
rich editor support, and handles rendering these sections in emails and
excerpts. It renders to the native HTML `<details>`/`<summary>` elements.
## Usage
In your posts, surround text with `[details=your summary]` ... `[/details]`.
For example:
``` text
I watched the murder mystery on TV last night. [details=Who did it?]The butler did it[/details].
```
## Issues
If you have issues or suggestions for the plugin, please bring them up on [Discourse Meta](https://meta.discourse.org).
## License
MIT