Skip to content

Commit 5fa28ec

Browse files
authored
Merge pull request #379 from machow/docs-sidebar-yaml
docs: fix sidebar preview and collapse
2 parents 334bdc1 + d7c3756 commit 5fa28ec

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ docs-build-readme:
4545

4646
docs-build: export PLUM_SIMPLE_DOC=1
4747
docs-build: docs-build-examples
48-
cd docs && quarto add --no-prompt ..
49-
cd docs && quartodoc build
48+
cd docs && quartodoc build --verbose
5049
cd docs && quartodoc interlinks
50+
cd docs && quarto add --no-prompt ..
5151
quarto render docs
5252

5353
test-interlinks: quartodoc/tests/example_interlinks/test.md

docs/get-started/sidebar.qmd

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ 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+
::: { .callout-note}
2627
Here is what the sidebar for the [quartodoc reference page](/api) looks like:
2728

28-
<div class="sourceCode">
29-
<pre class="sourceCode yaml"><code class="sourceCode yaml">{{< include /api/_sidebar.yml >}}
30-
</code></pre>
31-
</div>
29+
<details>
30+
```yaml
31+
{{< include /api/_sidebar.yml >}}
32+
```
33+
</details>
34+
35+
:::
3236

3337
## Customizing the sidebar
3438

0 commit comments

Comments
 (0)