Skip to content

Commit

Permalink
📖 Remove warnings (#1853)
Browse files Browse the repository at this point in the history
`site-options` --> `#site-options` and linting
  • Loading branch information
rowanc1 authored Feb 9, 2025
1 parent c1b5372 commit 9b9fa00
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/website-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In the [default MyST templates](./website-templates.md) there are several sectio
Here's how you can configure them.

:::{seealso} For all theme options
See [](site-options) for a list of all site options in both of the default themes.
See [](#site-options) for a list of all site options in both of the default themes.
:::

## Website Layout
Expand All @@ -29,6 +29,7 @@ Other themes may have slightly different structure.
- **[Footer](#navigation:footer)**: (work in progress) Contains more in-depth site navigation.

(navigation:header)=

## Header

(site-navigation)=
Expand All @@ -51,7 +52,7 @@ site:

There are a few types of entries you can define:

:::{list-table}
````{list-table}
:header-rows: 1
- * Type
* Pattern
Expand All @@ -65,7 +66,7 @@ There are a few types of entries you can define:
- * **External URLs**
* ```yaml
- title: Custom title
url: https://somelink.org`
url: https://somelink.org
```
* Direct links to an external website. This should be a fully-specified URL.
- * **Dropdowns**
Expand All @@ -76,8 +77,7 @@ There are a few types of entries you can define:
- url: pagetwo
```
* Becomes a dropdown with other entries inside.
:::
````

### Action Buttons

Expand All @@ -95,11 +95,9 @@ site:
url: https://mystmd.org
```


There are two types of actions:


:::{list-table}
````{list-table}
:header-rows: 1
- * Type
* Pattern
Expand All @@ -116,9 +114,10 @@ There are two types of actions:
url: https://somelink.org`
```
* Direct links to an external website. This should be a fully-specified URL.
:::
````

(navigation:sidebar-primary)=

## Primary sidebar (Table of Contents)

Is defined by your [MyST Project Table of Contents](./table-of-contents.md).
Expand All @@ -135,12 +134,14 @@ site:
```

(navigation:content-window)=

## Content window

Is populated with page-level metadata and your page's content.
See [](./frontmatter.md) for many kinds of metadata that configure this section.

(navigation:sidebar-secondary)=

## Secondary sidebar

Contains the in-page navigation of the page, autopopulated by the page's header structure.
Expand All @@ -157,11 +158,10 @@ site:
```

(navigation:footer)=

## Footer

:::{warning} Work in progress
Default footer support is not yet avialable.
See https://github.com/jupyter-book/myst-theme/issues/448 to provide feedback on this feature.
:::
+++

0 comments on commit 9b9fa00

Please sign in to comment.