Skip to content

Commit 07d4a0f

Browse files
committed
docs: create section for sidebar config
1 parent b5d3c69 commit 07d4a0f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/get-started/sidebar.qmd

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ with a [Quarto sidebar configuration](https://quarto.org/docs/websites/website-n
2323
The Quarto [`metadata-files` option](https://quarto.org/docs/projects/quarto-projects.html#metadata-includes) ensures
2424
it's included with the configuration in `_quarto.yml`.
2525

26+
Here is what the sidebar for the [quartodoc reference page](/api) looks like:
27+
28+
<div class="sourceCode">
29+
<pre class="sourceCode yaml"><code class="sourceCode yaml">{{< include /api/_sidebar.yml >}}
30+
</code></pre>
31+
</div>
32+
33+
## Customizing the sidebar
34+
2635
`sidebar` can also accept additional [sidebar options from the choices available in Quarto](https://quarto.org/docs/websites/website-navigation.html#side-navigation). These options are passed directly to Quarto, and can be used to customize the sidebar's appearance and behavior, or include additional content.
2736

2837
When using a dictionary for `sidebar`, use `file` to specify the sidebar file (defaults to `_quartodoc-sidebar.yml` if not provided). You can also provide additional content in the sidebar. Tell quartodoc where to include your package documentation in the sidebar with the `"{{ contents }}"` placeholder.
@@ -43,10 +52,3 @@ quartodoc:
4352
- text: "Basics"
4453
href: basics-summary.qmd
4554
```
46-
47-
Here is what the sidebar for the [quartodoc reference page](/api) looks like:
48-
49-
<div class="sourceCode">
50-
<pre class="sourceCode yaml"><code class="sourceCode yaml">{{< include /api/_sidebar.yml >}}
51-
</code></pre>
52-
</div>

0 commit comments

Comments
 (0)