From 8fe1666ad7a0e55b42529771543fac3c2660ccef Mon Sep 17 00:00:00 2001 From: TetraTheta <37061801+TetraTheta@users.noreply.github.com> Date: Sat, 17 Dec 2022 02:22:18 +0900 Subject: [PATCH] Add 'literate-nav' plugin scheme --- .../schema/plugins/external/literate-nav.json | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 docs/schema/plugins/external/literate-nav.json diff --git a/docs/schema/plugins/external/literate-nav.json b/docs/schema/plugins/external/literate-nav.json new file mode 100644 index 000000000..53fd6970d --- /dev/null +++ b/docs/schema/plugins/external/literate-nav.json @@ -0,0 +1,27 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "title": "Literate nav plugin", + "type": "object", + "properties": { + "literate-nav": { + "markdownDescription": "https://github.com/oprypin/mkdocs-literate-nav", + "type": "object", + "properties": { + "nav_file": { + "title": "The name of the file to read to determine the navigation for a particular directory under `docs_dir`", + "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#nav_file", + "type": "string", + "default": "SUMMARY.md" + }, + "implicit_index": { + "title": "If set and a directory has a file named `index.md` or `README.md`, but the literate nav for that directory that never includes it, it will be inserted as the first item of the nav", + "markdownDescription": "https://oprypin.github.io/mkdocs-literate-nav/reference.html#implicit_index", + "type": "boolean", + "default": false + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false +}