From 38a08cd25aa89f55e2ae6d5e5a4160fada111680 Mon Sep 17 00:00:00 2001 From: CDN Date: Tue, 5 Nov 2024 13:36:43 +0000 Subject: [docs] add zh docs (#3507) * [docs] add zh docs * [docs] add lang dropdown * [docs] update mkdocs zh config * [docs] migrate assets * [docs] update overrides dir in mkdocs zh config * [docs] exclude locales director in main mkdocs config * [docs] rename assets to public to avoid conflicting with template * [docs] extra_css change followup * [docs] add theme.palette.toggle.icon back into mkdocs zh config * [docs] fix zh readme reference + migrate language-specific repo markdown to docs * [docs] translate remaining repo docs + update reference * [docs] update zh index.md reference * [docs/zh] wording alignment --- mkdocs.yml | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'mkdocs.yml') diff --git a/mkdocs.yml b/mkdocs.yml index 4f179f1a4..1b12db12b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,7 @@ theme: name: material language: en font: false + custom_dir: docs/overrides features: - header.autohide - content.code.copy @@ -34,8 +35,17 @@ plugins: syntaxHighlightTheme: obsidian - include-markdown +extra: + alternate: + - name: English + link: /en/ + lang: en + - name: 中文 + link: /zh-cn/ + lang: zh + extra_css: - - assets/css/colours.css + - public/css/colours.css markdown_extensions: - admonition @@ -57,6 +67,9 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true +exclude_docs: | + locales/** + nav: - "Home": "index.md" - "FAQ": "faq.md" -- cgit v1.3