Merge pull request #379 from machow/docs-sidebar-yaml

docs: fix sidebar preview and collapse
machow · Nov 8, 2024 · 5fa28ec · 5fa28ec
2 parents 334bdc1 + d7c3756
commit 5fa28ec
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -45,9 +45,9 @@ docs-build-readme:
 
 docs-build: export PLUM_SIMPLE_DOC=1
 docs-build: docs-build-examples
-	cd docs && quarto add --no-prompt ..
-	cd docs && quartodoc build
+	cd docs && quartodoc build --verbose
 	cd docs && quartodoc interlinks
+	cd docs && quarto add --no-prompt ..
 	quarto render docs
 
 test-interlinks: quartodoc/tests/example_interlinks/test.md
diff --git a/docs/get-started/sidebar.qmd b/docs/get-started/sidebar.qmd
@@ -23,12 +23,16 @@ with a [Quarto sidebar configuration](https://quarto.org/docs/websites/website-n
 The Quarto [`metadata-files` option](https://quarto.org/docs/projects/quarto-projects.html#metadata-includes) ensures
 it's included with the configuration in `_quarto.yml`.
 
+::: { .callout-note}
 Here is what the sidebar for the [quartodoc reference page](/api) looks like:
 
-<div class="sourceCode">
-<pre class="sourceCode yaml"><code class="sourceCode yaml">{{< include /api/_sidebar.yml >}}
-</code></pre>
-</div>
+<details>
+```yaml
+{{< include /api/_sidebar.yml >}}
+```
+</details>
+
+:::
 
 ## Customizing the sidebar