Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix sidebar preview and collapse #379

Merged
merged 3 commits into from
Nov 8, 2024
Merged

docs: fix sidebar preview and collapse #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a40790
docs: fix sidebar preview and collapse
machow Nov 4, 2024
6b7ce19
dev: quartodoc build in Makefile now verbose
machow Nov 8, 2024
d7c3756
dev: switch order of building API and adding extensions
machow Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 8 additions & 4 deletions docs/get-started/sidebar.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading