We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 9564bbd commit c17892aCopy full SHA for c17892a
docs/get-started/basic-content.qmd
@@ -165,6 +165,7 @@ quartodoc:
165
# contents with a page grouping ----
166
contents:
167
- kind: page
168
+ path: some_funcs
169
170
- get_object
171
- name: MdRenderer
@@ -174,6 +175,15 @@ quartodoc:
174
175
:::
176
::::::
177
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
187
188
## Setting default package path
189
0 commit comments