refactor: mkdocs moved to docs/main

LiteLDev · Nov 3, 2024 · 75b47b8 · 75b47b8
1 parent dff8676
commit 75b47b8
Show file tree

Hide file tree

Showing 40 changed files with 12 additions and 32 deletions.
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -16,8 +16,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - run: |
-          cd docs/api/
-          git clone --depth 1 --branch v2.3.4 https://github.com/jothepro/doxygen-awesome-css.git
+          git clone --depth 1 --branch v2.3.4 https://github.com/jothepro/doxygen-awesome-css.git docs/api/doxygen-awesome-css
           
       - run : |
           mkdir -p site/api
@@ -41,10 +40,10 @@ jobs:
       - uses: actions/checkout@v4
 
       - run: |
-          pip install -r requirements.txt
+          pip install -r docs/main/requirements.txt
 
       - run: |
-          mkdocs build
+          mkdocs build -f docs/main/mkdocs.yml -d ../../site
 
       - run: |
           tar -cvf artifact.tar -C site/ .

diff --git a/docs/img/logo_small.svg b/docs/img/logo_small.svg
diff --git a/...developer_guides/create_your_first_mod.md → ...developer_guides/create_your_first_mod.md b/...developer_guides/create_your_first_mod.md → ...developer_guides/create_your_first_mod.md
@@ -64,7 +64,7 @@ Then, you need to install LeviLamina somewhere. This tutorial is for LeviLamina
 
 Visit [levilamina-mod-template](https://github.com/LiteLDev/levilamina-mod-template) and click `Use this template` to use this template to initialize your mod repository.
 
-![Create from template](img/levilamina-mod-template.png)
+![Create from template](levilamina-mod-template.png)
 
 Clone the mod repository to your local machine using Git, and then open it with VSCode. You need to modify some of the files to fill in your mod information.
 

diff --git a/...eloper_guides/create_your_first_mod.zh.md → ...eloper_guides/create_your_first_mod.zh.md b/...eloper_guides/create_your_first_mod.zh.md → ...eloper_guides/create_your_first_mod.zh.md
@@ -64,7 +64,7 @@
 
 访问[levilamina-mod-template](https://github.com/LiteLDev/levilamina-mod-template)，点击`Use this template`以使用这个模板初始化你的模组仓库。
 
-![Create from template](img/levilamina-mod-template.png)
+![Create from template](levilamina-mod-template.png)
 
 将模组仓库使用Git克隆到本地，然后使用VSCode打开。你需要修改其中的一些文件，填写你的模组信息。
 

diff --git a/...loper_guides/how_to_guides/event_guide.md → ...loper_guides/how_to_guides/event_guide.md b/...loper_guides/how_to_guides/event_guide.md → ...loper_guides/how_to_guides/event_guide.md
diff --git a/...er_guides/how_to_guides/event_guide.zh.md → ...er_guides/how_to_guides/event_guide.zh.md b/...er_guides/how_to_guides/event_guide.zh.md → ...er_guides/how_to_guides/event_guide.zh.md
diff --git a/...s/how_to_guides/export_interface_guide.md → ...s/how_to_guides/export_interface_guide.md b/...s/how_to_guides/export_interface_guide.md → ...s/how_to_guides/export_interface_guide.md
diff --git a/...ow_to_guides/export_interface_guide.zh.md → ...ow_to_guides/export_interface_guide.zh.md b/...ow_to_guides/export_interface_guide.zh.md → ...ow_to_guides/export_interface_guide.zh.md
diff --git a/...ides/how_to_guides/find_function_guide.md → ...ides/how_to_guides/find_function_guide.md b/...ides/how_to_guides/find_function_guide.md → ...ides/how_to_guides/find_function_guide.md
diff --git a/...s/how_to_guides/find_function_guide.zh.md → ...s/how_to_guides/find_function_guide.zh.md b/...s/how_to_guides/find_function_guide.zh.md → ...s/how_to_guides/find_function_guide.zh.md
diff --git a/...eloper_guides/how_to_guides/form_guide.md → ...eloper_guides/how_to_guides/form_guide.md b/...eloper_guides/how_to_guides/form_guide.md → ...eloper_guides/how_to_guides/form_guide.md
diff --git a/...per_guides/how_to_guides/form_guide.zh.md → ...per_guides/how_to_guides/form_guide.zh.md b/...per_guides/how_to_guides/form_guide.zh.md → ...per_guides/how_to_guides/form_guide.zh.md
diff --git a/...eloper_guides/how_to_guides/hook_guide.md → ...eloper_guides/how_to_guides/hook_guide.md b/...eloper_guides/how_to_guides/hook_guide.md → ...eloper_guides/how_to_guides/hook_guide.md
diff --git a/...per_guides/how_to_guides/hook_guide.zh.md → ...per_guides/how_to_guides/hook_guide.zh.md b/...per_guides/how_to_guides/hook_guide.zh.md → ...per_guides/how_to_guides/hook_guide.zh.md
diff --git a/...eloper_guides/how_to_guides/i18n_guide.md → ...eloper_guides/how_to_guides/i18n_guide.md b/...eloper_guides/how_to_guides/i18n_guide.md → ...eloper_guides/how_to_guides/i18n_guide.md
diff --git a/...per_guides/how_to_guides/i18n_guide.zh.md → ...per_guides/how_to_guides/i18n_guide.zh.md b/...per_guides/how_to_guides/i18n_guide.zh.md → ...per_guides/how_to_guides/i18n_guide.zh.md
diff --git a/...eloper_guides/how_to_guides/item_guide.md → ...eloper_guides/how_to_guides/item_guide.md b/...eloper_guides/how_to_guides/item_guide.md → ...eloper_guides/how_to_guides/item_guide.md
diff --git a/...per_guides/how_to_guides/item_guide.zh.md → ...per_guides/how_to_guides/item_guide.zh.md b/...per_guides/how_to_guides/item_guide.zh.md → ...per_guides/how_to_guides/item_guide.zh.md
diff --git a/..._guides/how_to_guides/permission_guide.md → ..._guides/how_to_guides/permission_guide.md b/..._guides/how_to_guides/permission_guide.md → ..._guides/how_to_guides/permission_guide.md
diff --git a/...ides/how_to_guides/permission_guide.zh.md → ...ides/how_to_guides/permission_guide.zh.md b/...ides/how_to_guides/permission_guide.zh.md → ...ides/how_to_guides/permission_guide.zh.md
diff --git a/...er_guides/img/levilamina-mod-template.png → ...eloper_guides/levilamina-mod-template.png b/...er_guides/img/levilamina-mod-template.png → ...eloper_guides/levilamina-mod-template.png
diff --git a/...eveloper_guides/publish_your_first_mod.md → ...eveloper_guides/publish_your_first_mod.md b/...eveloper_guides/publish_your_first_mod.md → ...eveloper_guides/publish_your_first_mod.md
diff --git a/...loper_guides/publish_your_first_mod.zh.md → ...loper_guides/publish_your_first_mod.zh.md b/...loper_guides/publish_your_first_mod.zh.md → ...loper_guides/publish_your_first_mod.zh.md
diff --git a/...veloper_guides/publish_your_first_pack.md → ...veloper_guides/publish_your_first_pack.md b/...veloper_guides/publish_your_first_pack.md → ...veloper_guides/publish_your_first_pack.md
diff --git a/...oper_guides/publish_your_first_pack.zh.md → ...oper_guides/publish_your_first_pack.zh.md b/...oper_guides/publish_your_first_pack.zh.md → ...oper_guides/publish_your_first_pack.zh.md
diff --git a/docs/faq.md → docs/main/faq.md b/docs/faq.md → docs/main/faq.md
diff --git a/docs/faq.zh.md → docs/main/faq.zh.md b/docs/faq.zh.md → docs/main/faq.zh.md
diff --git a/docs/img/favicon.ico → docs/main/favicon.ico b/docs/img/favicon.ico → docs/main/favicon.ico
diff --git a/docs/index.md → docs/main/index.md b/docs/index.md → docs/main/index.md
diff --git a/docs/index.zh.md → docs/main/index.zh.md b/docs/index.zh.md → docs/main/index.zh.md
diff --git a/docs/img/logo.svg → docs/main/logo.svg b/docs/img/logo.svg → docs/main/logo.svg
diff --git a/docs/maintainer_guides/cpp_style_guide.md → ...main/maintainer_guides/cpp_style_guide.md b/docs/maintainer_guides/cpp_style_guide.md → ...main/maintainer_guides/cpp_style_guide.md
diff --git a/mkdocs.yml → docs/main/mkdocs.yml b/mkdocs.yml → docs/main/mkdocs.yml
@@ -1,5 +1,10 @@
 site_name: LeviLamina Docs
 repo_url: https://github.com/LiteLDev/LeviLamina
+docs_dir: .
+
+exclude_docs: |
+  /mkdocs.yml
+  /requirements.txt
 
 nav:
   - Home: index.md
@@ -32,16 +37,13 @@ nav:
   - Maintainer Guides:
     - maintainer_guides/cpp_style_guide.md
 
-exclude_docs: |
-  api/assets/
-
 theme:
   name: material
   features:
     - navigation.tabs
     - navigation.tabs.sticky
-  favicon: img/favicon.ico
-  logo: img/logo.svg
+  favicon: favicon.ico
+  logo: logo.svg
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default

diff --git a/docs/player_guides/install.md → docs/main/player_guides/install.md b/docs/player_guides/install.md → docs/main/player_guides/install.md
diff --git a/docs/player_guides/install.zh.md → docs/main/player_guides/install.zh.md b/docs/player_guides/install.zh.md → docs/main/player_guides/install.zh.md
diff --git a/docs/player_guides/troubleshooting.md → docs/main/player_guides/troubleshooting.md b/docs/player_guides/troubleshooting.md → docs/main/player_guides/troubleshooting.md
diff --git a/docs/player_guides/troubleshooting.zh.md → .../main/player_guides/troubleshooting.zh.md b/docs/player_guides/troubleshooting.zh.md → .../main/player_guides/troubleshooting.zh.md
diff --git a/docs/quickstart.md → docs/main/quickstart.md b/docs/quickstart.md → docs/main/quickstart.md
diff --git a/docs/quickstart.zh.md → docs/main/quickstart.zh.md b/docs/quickstart.zh.md → docs/main/quickstart.zh.md
diff --git a/requirements.txt → docs/main/requirements.txt b/requirements.txt → docs/main/requirements.txt