Skip to content

Commit c17892a

Browse files
committed
docs: fix content config page example
1 parent 9564bbd commit c17892a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/get-started/basic-content.qmd

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ quartodoc:
165165
# contents with a page grouping ----
166166
contents:
167167
- kind: page
168+
path: some_funcs
168169
contents:
169170
- get_object
170171
- name: MdRenderer
@@ -174,6 +175,15 @@ quartodoc:
174175
:::
175176
::::::
176177

178+
Note these three important pieces of the page entry:
179+
180+
* `kind: page` - indicates that we are creating a page
181+
* `path:` - specifies what the name of the page will be in the generated docs.
182+
For example, `path: some_funcs` in the config above produces a file called
183+
`some_funcs.qmd` in the API reference folder.
184+
* `contents:` - lists out the contents of the page.
185+
186+
177187

178188
## Setting default package path
179189

0 commit comments

Comments
 (0)