diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index f0eb626bdc..b3858a3884 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -14,18 +14,21 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - with: - submodules: true - run: | + 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 - - uses: mattnotmitt/doxygen-action@1.9.5 + - uses: mattnotmitt/doxygen-action@v1 + with: + doxyfile-path: ./docs/api/Doxyfile - run: | tar -cvf artifact.tar -C site/ . - - uses: actions/upload-artifact@v3 + - uses: actions/upload-artifact@v4 with: name: doxygen-pages path: | @@ -37,15 +40,15 @@ 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/ . - - uses: actions/upload-artifact@v3 + - uses: actions/upload-artifact@v4 with: name: mkdocs-pages path: | @@ -57,7 +60,7 @@ jobs: - build-mkdocs runs-on: ubuntu-latest steps: - - uses: actions/download-artifact@v3 + - uses: actions/download-artifact@v4 with: path: artifacts/ @@ -67,7 +70,7 @@ jobs: tar -xvf artifacts/doxygen-pages/artifact.tar -C site/ tar -xvf artifacts/mkdocs-pages/artifact.tar -C site/ - - uses: actions/upload-pages-artifact@v2 + - uses: actions/upload-pages-artifact@v3 with: path: site/ @@ -80,4 +83,4 @@ jobs: pages: write runs-on: ubuntu-latest steps: - - uses: actions/deploy-pages@v2 + - uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index 0d4b0f3f84..4db09f9eb2 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,7 @@ *.app + ## https://github.com/github/gitignore/blob/main/CMake.gitignore CMakeLists.txt.user CMakeCache.txt @@ -46,6 +47,7 @@ compile_commands.json CTestTestfile.cmake + ## https://github.com/github/gitignore/blob/main/VisualStudio.gitignore ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. @@ -437,6 +439,7 @@ FodyWeavers.xsd *.sln.iml + ## https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore .vscode/* !.vscode/settings.json @@ -452,6 +455,7 @@ FodyWeavers.xsd *.vsix + ## https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 @@ -532,22 +536,25 @@ fabric.properties .idea/caches/build_file_checksums.ser -## XMake + +## Miscellaneous +# XMake /.xmake/ /build/ /CMakeLists.txt /vsxmake2022 -# MkDocs +## Documentation +/docs/api/doxygen-awesome-css/ /site/ -## Project specific # IDE -/.idea/ -/.vscode/ +.idea/ +.vscode/ + +# Testing +/bin/ +/src/ll/test/include_all.cpp +/src-test/**/include_all.cpp -# Test -src-test/**/include_all.cpp -bin/ -src/ll/test/include_all.cpp diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 090915e637..0000000000 --- a/.gitmodules +++ /dev/null @@ -1,3 +0,0 @@ -[submodule "docs/api/assets/doxygen-awesome-css"] - path = docs/api/assets/doxygen-awesome-css - url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/Doxyfile b/docs/api/Doxyfile similarity index 99% rename from Doxyfile rename to docs/api/Doxyfile index bc470bc9da..84e3e68d09 100644 --- a/Doxyfile +++ b/docs/api/Doxyfile @@ -61,7 +61,7 @@ PROJECT_BRIEF = # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = docs/img/logo_small.svg +PROJECT_LOGO = docs/api/logo.svg # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -815,7 +815,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = DoxygenLayout.xml +LAYOUT_FILE = docs/api/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -1309,7 +1309,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = docs/api/assets/header.html +HTML_HEADER = docs/api/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1349,7 +1349,7 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = docs/api/assets/doxygen-awesome-css/doxygen-awesome.css +HTML_EXTRA_STYLESHEET = docs/api/doxygen-awesome-css/doxygen-awesome.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1359,7 +1359,7 @@ HTML_EXTRA_STYLESHEET = docs/api/assets/doxygen-awesome-css/doxygen-awesome.css # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = docs/api/assets/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js +HTML_EXTRA_FILES = docs/api/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/DoxygenLayout.xml b/docs/api/DoxygenLayout.xml similarity index 100% rename from DoxygenLayout.xml rename to docs/api/DoxygenLayout.xml diff --git a/docs/api/assets/doxygen-awesome-css b/docs/api/assets/doxygen-awesome-css deleted file mode 160000 index df83fbf22c..0000000000 --- a/docs/api/assets/doxygen-awesome-css +++ /dev/null @@ -1 +0,0 @@ -Subproject commit df83fbf22cfff76b875c13d324baf584c74e96d0 diff --git a/docs/api/assets/header.html b/docs/api/header.html similarity index 100% rename from docs/api/assets/header.html rename to docs/api/header.html diff --git a/docs/img/logo_small.svg b/docs/api/logo.svg similarity index 100% rename from docs/img/logo_small.svg rename to docs/api/logo.svg 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