Skip to content

Commit

Permalink
add metadata key
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Jul 2, 2023
1 parent 786acb8 commit 21f373a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docs/community/topics/page-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,20 @@ This is [similar to how the TOML language defines nested configuration](https://

For example, to remove the secondary sidebar, we use a page metadata key like this:

`````{tab-set}
````{tab-item}
```rst
:html_theme.sidebar_secondary.remove: true
```
````
````tab-item
```md
---
html_theme.sidebar_secondary.remove: true
---
```
````
`````

Note how the period naturally separates nested sections, and looks very similar to what we'd expect if we put this in a Python dictionary in `conf.py`:

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/static_assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ If you're using either the raw directive (reStructuredText) or pure html (MyST M

``````{tab-set}
`````{tab-item} rst
````{ code-block} rst
````{code-block} rst
:caption: some_page_in_my_site.rst
.. raw:: html
Expand Down

0 comments on commit 21f373a

Please sign in to comment.