diff --git a/.documentation/JAVADOC-README.md b/.documentation/JAVADOC-README.md deleted file mode 100644 index 068757b..0000000 --- a/.documentation/JAVADOC-README.md +++ /dev/null @@ -1,9 +0,0 @@ -# EasyConfiguration Javadoc - -基于 [Github Pages](https://pages.github.com/) 搭建,请访问 [JavaDoc](https://carmjos.github.io/EasyConfiguration) 。 - -## 如何实现? - -若您也想通过 [Github Actions](https://docs.github.com/en/actions/learn-github-actions) -自动部署项目的Javadoc到 [Github Pages](https://pages.github.com/) , -可以参考我的文章 [《自动部署Javadoc到Github Pages》](https://pages.carm.cc/doc/javadoc-in-github.html) 。 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 7b2557f..c26a2a6 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -29,59 +29,13 @@ jobs: gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase - - name: "Maven Deploy With Javadoc" + - name: "Maven Deploy" run: mvn -B -Pgithub deploy --file pom.xml -DskipTests env: MAVEN_USERNAME: ${{ github.repository_owner }} MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}} MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }} - - name: "Copy Javadoc to Location" - run: | - rm -rf docs - mkdir -vp docs - cp -vrf core/target/apidocs/* docs/ - cp -vrf .documentation/JAVADOC-README.md docs/README.md - - - name: "Generate the Javadoc sitemap" - id: sitemap - uses: cicirello/generate-sitemap@v1 - with: - base-url-path: https://CarmJos.github.io/EasyConfiguration - path-to-root: docs - - - name: "Output stats" - run: | - echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}" - echo "url-count = ${{ steps.sitemap.outputs.url-count }}" - echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}" - - - name: "Configure Git" - env: - DEPLOY_PRI: ${{secrets.DEPLOY_PRI}} - run: | - sudo timedatectl set-timezone "Asia/Shanghai" - mkdir -p ~/.ssh/ - echo "$DEPLOY_PRI" > ~/.ssh/id_rsa - chmod 600 ~/.ssh/id_rsa - ssh-keyscan github.com >> ~/.ssh/known_hosts - git config --global user.name 'CarmJos' - git config --global user.email 'carm@carm.cc' - - - name: "Commit documentations" - run: | - cd docs - git init - git remote add origin git@github.com:CarmJos/EasyConfiguration.git - git checkout -b gh-pages - git add -A - git commit -m "API Document generated." - - - name: "Push javadocs" - run: | - cd docs - git push origin HEAD:gh-pages --force - central-deploy: name: "Deploy Project (Central Repository)" runs-on: ubuntu-latest diff --git a/README.md b/README.md index f4a726b..d5c4c4b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,18 @@ EasyConfiguration for MineCraft! ## 开发 ### 项目结构 + +#### MineConfiguration-CraftBukkit + +CraftBukkit系通用依赖,不包含实现部分,请使用 MineConfiguration-Bukkit 或 MineConfiguration-Spigot 。 + +相较于基础版本,额外提供了以下功能: +- `ConfiguredSerializable` +- `ConfiguredItem` (快捷读取简单的物品配置文件) +- `ConfiguredSound` (快捷读取音效配置文件) + +以上类型可以通过 `CraftConfigValue.builder()` 来创建,部分类型提供了 `of(...);` 方法来快速创建。 + #### MineConfiguration-Bukkit 适用于Bukkit的版本,包含以Bukkit为基础的其他服务端*(如Spigot、Paper、CatServer)*。 @@ -32,7 +44,6 @@ EasyConfiguration for MineCraft! #### MineConfiguration-Bungee 适用于BungeeCord的版本,可用JSON与YAML格式,但**不支持配置文件注释**。 - 如需使用配置文件注释,建议使用 [EasyConfiguration-YAML](https://github.com/CarmJos/EasyConfiguration) 。 ### 依赖方式