Skip to content

📚 DOCS:: Update for dropdown class #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2020
Merged

📚 DOCS:: Update for dropdown class #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,26 @@ extensions = [
]
```
Now, whenever you wish for an admonition to be toggle-able, add the
`:class: toggle` parameter to the admonition directive that you use.
`:class: dropdown` parameter to the admonition directive that you use.

For example, this code would create a toggle-able "note" admonition:
For example, this code would create a toggle-able "note" admonition
that starts hidden:

```rst
.. note::
:class: toggle
:class: dropdown

This is my note.
```

Clicking on the toggle button will toggle the item's visibility.

You may also **hide the content by default**. To do so, add the `toggle`
class *as well as* a `toggle-hidden` class, like so:
You may also **show the content by default**. To do so, add the `dropdown`
class *as well as* a `toggle-shown` class, like so:

```rst
.. note::
:class: toggle, toggle-hidden
:class: dropdown, toggle-shown

This is my note.
```
Expand Down