diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 5a2ce7fc68..b3858a3884 100644 --- 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 deleted file mode 100644 index 9ceb950ac7..0000000000 --- a/docs/img/logo_small.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/developer_guides/create_your_first_mod.md b/docs/main/developer_guides/create_your_first_mod.md similarity index 99% rename from docs/developer_guides/create_your_first_mod.md rename to docs/main/developer_guides/create_your_first_mod.md index a87ae89b82..433a2b3f8f 100644 --- a/docs/developer_guides/create_your_first_mod.md +++ b/docs/main/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/docs/developer_guides/create_your_first_mod.zh.md b/docs/main/developer_guides/create_your_first_mod.zh.md similarity index 99% rename from docs/developer_guides/create_your_first_mod.zh.md rename to docs/main/developer_guides/create_your_first_mod.zh.md index c17672fa4e..fa9d295a87 100644 --- a/docs/developer_guides/create_your_first_mod.zh.md +++ b/docs/main/developer_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/docs/developer_guides/how_to_guides/event_guide.md b/docs/main/developer_guides/how_to_guides/event_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/event_guide.md rename to docs/main/developer_guides/how_to_guides/event_guide.md diff --git a/docs/developer_guides/how_to_guides/event_guide.zh.md b/docs/main/developer_guides/how_to_guides/event_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/event_guide.zh.md rename to docs/main/developer_guides/how_to_guides/event_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/export_interface_guide.md b/docs/main/developer_guides/how_to_guides/export_interface_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/export_interface_guide.md rename to docs/main/developer_guides/how_to_guides/export_interface_guide.md diff --git a/docs/developer_guides/how_to_guides/export_interface_guide.zh.md b/docs/main/developer_guides/how_to_guides/export_interface_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/export_interface_guide.zh.md rename to docs/main/developer_guides/how_to_guides/export_interface_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/find_function_guide.md b/docs/main/developer_guides/how_to_guides/find_function_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/find_function_guide.md rename to docs/main/developer_guides/how_to_guides/find_function_guide.md diff --git a/docs/developer_guides/how_to_guides/find_function_guide.zh.md b/docs/main/developer_guides/how_to_guides/find_function_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/find_function_guide.zh.md rename to docs/main/developer_guides/how_to_guides/find_function_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/form_guide.md b/docs/main/developer_guides/how_to_guides/form_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/form_guide.md rename to docs/main/developer_guides/how_to_guides/form_guide.md diff --git a/docs/developer_guides/how_to_guides/form_guide.zh.md b/docs/main/developer_guides/how_to_guides/form_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/form_guide.zh.md rename to docs/main/developer_guides/how_to_guides/form_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/hook_guide.md b/docs/main/developer_guides/how_to_guides/hook_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/hook_guide.md rename to docs/main/developer_guides/how_to_guides/hook_guide.md diff --git a/docs/developer_guides/how_to_guides/hook_guide.zh.md b/docs/main/developer_guides/how_to_guides/hook_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/hook_guide.zh.md rename to docs/main/developer_guides/how_to_guides/hook_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/i18n_guide.md b/docs/main/developer_guides/how_to_guides/i18n_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/i18n_guide.md rename to docs/main/developer_guides/how_to_guides/i18n_guide.md diff --git a/docs/developer_guides/how_to_guides/i18n_guide.zh.md b/docs/main/developer_guides/how_to_guides/i18n_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/i18n_guide.zh.md rename to docs/main/developer_guides/how_to_guides/i18n_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/item_guide.md b/docs/main/developer_guides/how_to_guides/item_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/item_guide.md rename to docs/main/developer_guides/how_to_guides/item_guide.md diff --git a/docs/developer_guides/how_to_guides/item_guide.zh.md b/docs/main/developer_guides/how_to_guides/item_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/item_guide.zh.md rename to docs/main/developer_guides/how_to_guides/item_guide.zh.md diff --git a/docs/developer_guides/how_to_guides/permission_guide.md b/docs/main/developer_guides/how_to_guides/permission_guide.md similarity index 100% rename from docs/developer_guides/how_to_guides/permission_guide.md rename to docs/main/developer_guides/how_to_guides/permission_guide.md diff --git a/docs/developer_guides/how_to_guides/permission_guide.zh.md b/docs/main/developer_guides/how_to_guides/permission_guide.zh.md similarity index 100% rename from docs/developer_guides/how_to_guides/permission_guide.zh.md rename to docs/main/developer_guides/how_to_guides/permission_guide.zh.md diff --git a/docs/developer_guides/img/levilamina-mod-template.png b/docs/main/developer_guides/levilamina-mod-template.png similarity index 100% rename from docs/developer_guides/img/levilamina-mod-template.png rename to docs/main/developer_guides/levilamina-mod-template.png diff --git a/docs/developer_guides/publish_your_first_mod.md b/docs/main/developer_guides/publish_your_first_mod.md similarity index 100% rename from docs/developer_guides/publish_your_first_mod.md rename to docs/main/developer_guides/publish_your_first_mod.md diff --git a/docs/developer_guides/publish_your_first_mod.zh.md b/docs/main/developer_guides/publish_your_first_mod.zh.md similarity index 100% rename from docs/developer_guides/publish_your_first_mod.zh.md rename to docs/main/developer_guides/publish_your_first_mod.zh.md diff --git a/docs/developer_guides/publish_your_first_pack.md b/docs/main/developer_guides/publish_your_first_pack.md similarity index 100% rename from docs/developer_guides/publish_your_first_pack.md rename to docs/main/developer_guides/publish_your_first_pack.md diff --git a/docs/developer_guides/publish_your_first_pack.zh.md b/docs/main/developer_guides/publish_your_first_pack.zh.md similarity index 100% rename from docs/developer_guides/publish_your_first_pack.zh.md rename to docs/main/developer_guides/publish_your_first_pack.zh.md diff --git a/docs/faq.md b/docs/main/faq.md similarity index 100% rename from docs/faq.md rename to docs/main/faq.md diff --git a/docs/faq.zh.md b/docs/main/faq.zh.md similarity index 100% rename from docs/faq.zh.md rename to docs/main/faq.zh.md diff --git a/docs/img/favicon.ico b/docs/main/favicon.ico similarity index 100% rename from docs/img/favicon.ico rename to docs/main/favicon.ico diff --git a/docs/index.md b/docs/main/index.md similarity index 100% rename from docs/index.md rename to docs/main/index.md diff --git a/docs/index.zh.md b/docs/main/index.zh.md similarity index 100% rename from docs/index.zh.md rename to docs/main/index.zh.md diff --git a/docs/img/logo.svg b/docs/main/logo.svg similarity index 100% rename from docs/img/logo.svg rename to docs/main/logo.svg diff --git a/docs/maintainer_guides/cpp_style_guide.md b/docs/main/maintainer_guides/cpp_style_guide.md similarity index 100% rename from docs/maintainer_guides/cpp_style_guide.md rename to docs/main/maintainer_guides/cpp_style_guide.md diff --git a/mkdocs.yml b/docs/main/mkdocs.yml similarity index 96% rename from mkdocs.yml rename to docs/main/mkdocs.yml index 824afd7d77..f6dd0667f2 100644 --- a/mkdocs.yml +++ b/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 b/docs/main/player_guides/install.md similarity index 100% rename from docs/player_guides/install.md rename to docs/main/player_guides/install.md diff --git a/docs/player_guides/install.zh.md b/docs/main/player_guides/install.zh.md similarity index 100% rename from docs/player_guides/install.zh.md rename to docs/main/player_guides/install.zh.md diff --git a/docs/player_guides/troubleshooting.md b/docs/main/player_guides/troubleshooting.md similarity index 100% rename from docs/player_guides/troubleshooting.md rename to docs/main/player_guides/troubleshooting.md diff --git a/docs/player_guides/troubleshooting.zh.md b/docs/main/player_guides/troubleshooting.zh.md similarity index 100% rename from docs/player_guides/troubleshooting.zh.md rename to docs/main/player_guides/troubleshooting.zh.md diff --git a/docs/quickstart.md b/docs/main/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/main/quickstart.md diff --git a/docs/quickstart.zh.md b/docs/main/quickstart.zh.md similarity index 100% rename from docs/quickstart.zh.md rename to docs/main/quickstart.zh.md diff --git a/requirements.txt b/docs/main/requirements.txt similarity index 100% rename from requirements.txt rename to docs/main/requirements.txt