From 9a089d4886cfb293ee25ac3ca906a5713c8bb832 Mon Sep 17 00:00:00 2001 From: Kyriet Date: Sat, 11 Sep 2021 11:42:17 +0200 Subject: [PATCH] docs: add note about partials on Create doc page (#5543) --- website/docs/guides/docs/docs-create-doc.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/docs/guides/docs/docs-create-doc.mdx b/website/docs/guides/docs/docs-create-doc.mdx index c9289a2e0a..c42b1c32b0 100644 --- a/website/docs/guides/docs/docs-create-doc.mdx +++ b/website/docs/guides/docs/docs-create-doc.mdx @@ -84,6 +84,14 @@ With {#custom-id} syntax you can set your own header id. ``` +:::note + +All files prefixed with an underscore (`_`) under the `docs` directory are treated as "partial" pages and will be ignored by default. + +Read more about [importing partial pages](../markdown-features/markdown-features-react.mdx#importing-markdown). + +::: + ## Doc tags {#doc-tags} Optionally, you can add tags to your doc pages, which introduces another dimension of categorization in addition to the [docs sidebar](./sidebar.md). Tags are passed in the front matter as a list of labels: