Organize your docs to guide your users to the information they need
navigation
property controls the hierarchy of your documentation.
navigation
field.
Each entry of the pages
array must be a path to a file that exists within your repo.
Note you do not need to append .mdx
to the file paths.
navigation.global
property.
docs.json
will not show up in the sidebar but are
accessible by linking directly to them.
Hidden pages are not indexed for search within your docs by default. If you
would like to override this behavior, you can set the
seo.indexing
attribute
in your docs.json
to navigable
.
links
field in the docs.json
file.
links
field supports the following fields: label
, href
.
primary
field.
primary
field supports the following fields: label
, href
, type
. For more information on the options for these fields, see the docs.json schema.
primary
field with the type
set to github
.