meta-schema.json

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"title":{"description":"Name of the folder in the sidebar (page tree on the left)","type":"string"},"icon":{"description":"Icon of the folder in the sidebar (page tree on the left)","type":"string"},"root":{"description":"When set to `true`, only the items in this folder will be shown when navigating to them. \nRoot folders form the layout tabs (or dropdown) menu: https://www.fumadocs.dev/docs/ui/layouts/docs#layout-tabs","type":"boolean"},"defaultOpen":{"description":"When set to `true`, the folder will be opened by default. \nDefaults to `false`.","default":false,"type":"boolean"},"collapsible":{"description":"When set to `false`, the folder will **not** be collapsible. \nDefaults to `true`.","default":true,"type":"boolean"},"pagesIndex":{"description":"When a folder has an `index.mdx` file, clicks on the folder \nin the sidebar (page tree on the left) route to that page \nin addition to toggling the collapsible state of the folder. \n This field allows to specify a different index item of a folder as either: \n- Path — a string like `\"overview\"` (will look for `overview.mdx`) \n- Link — an external path like `\"[Link name](https://yourmom.zip)\"`","default":"index","anyOf":[{"type":"string","format":"Path","pattern":"^[\\.a-zA-Z_\\-0-9 \\/]+$"},{"type":"string","format":"Link","pattern":"^\\[.*?\\]\\(http.*?\\)$"}]},"description":{"description":"Description of the folder in the sidebar (page tree on the left). \nDirectly related to the index item set in the `pagesIndex` field.","type":"string"},"pages":{"description":"Array of pages in the folder. \nItems in the folder appear or disappear (see `\"!file\"`) in their listed order. \n \nThe following example documents available options and syntaxes for listing: \n \n```jsonc \n{ \n  \"pages\": [ \n    // A path to page or folder. File extensions are allowed, but discouraged. \n    \"components\", \n \n    // Exclude an item from being included in a folder. \n    \"!file\", \n \n    // A vertical separator between sections which can be prefixed with an [Icon] from Lucide. \n    \"---My Separator---\", \n \n    // Include the rest of the pages in alphabetical order. \n    \"...\", \n \n    // Include the rest of the pages in reverse-alphabetical order. \n    \"z...a\", \n \n    // Extract the items from a folder below. \n    \"...folder\" \n \n    // Insert a link. Can be prefixed with an [Icon] from Lucide. \n    \"[TON Docs](https://docs.ton.org)\", \n    \"[Triangle][TON Docs](https://docs.ton.org)\" \n \n    // Insert a link marked as external — it will have a special icon shown to the left of the name. \n    \"external:[TON website](https://ton.org)\" \n  ] \n} \n```","type":"array","items":{"anyOf":[{"type":"string","format":"Path","pattern":"^[\\.a-zA-Z_\\-0-9 \\/]+$"},{"type":"string","format":"Separator","pattern":"^---(\\[[a-zA-Z_\\-0-9]+\\])?[^\\-]+---$"},{"type":"string","format":"Link","pattern":"^(external:)?(\\[[a-zA-Z_\\-0-9]+\\])?\\[.*?\\]\\(.*?\\)$"},{"type":"string","format":"External link","pattern":"^external:\\[.*?\\]\\(.*?\\)$"},{"type":"string","format":"Rest","pattern":"^\\.\\.\\.$"},{"type":"string","format":"Reversed rest","pattern":"^z\\.\\.\\.a$"},{"type":"string","format":"Extract","pattern":"^\\.\\.\\.[a-zA-Z_\\-0-9 \\.]+$"},{"type":"string","format":"Except","pattern":"^\\![a-zA-Z_\\-0-9 \\.]+$"}]}},"tag":{"description":"Optional tag of the folder in the sidebar (page tree on the left). \nThis is custom field that extends the default schema.","type":"string"}},"additionalProperties":false}