From 062a7b434e38f203443d5bdfbfb211d2042994d8 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Fri, 17 Dec 2021 15:45:26 +0100 Subject: [PATCH 1/4] Update and rename index.html to index.md --- docs/index.html | 133 ------------------------------------------------ docs/index.md | 75 +++++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 133 deletions(-) delete mode 100644 docs/index.html create mode 100644 docs/index.md diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 0b7a14e..0000000 --- a/docs/index.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - JavaBotBlockAPI | Java Wrapper for the BotBlock API - - - - - - - - - - - -
-
-
-
-
-

JavaBotBlockAPI

-
-
-
-
-
-
-
-

About

-

JavaBotBlockAPI is the official Java Wrapper for the BotBlock API. -
It supports all GET and POST requests that the BotBlock API offers. - -

Modules

-

The Wrapper is split up into different modules to allow you more control about what you need. -
Current modules incude: -

    -
  • Core The main module needed for everything else.
    • -
  • Javacord Module to add support for the Javacord Library
    • -
  • JDA Module to add support for the JDA Library
    • -
  • Request Module for GET and POST requests from/to the BotBlock API. Javacord and JDA Module depend on this.
    • -
- -

Support

-

If you require support with this Wrapper, join Andre's Support Server. -
For help regarding the BotBlock API itself should you join the BotBlock Discord Server. -
The BotBlock Discord also has a #api Channel where you can ask for support regarding this wrapper. - -

Do NOT contact (Ping or DM) BotBlock Staff for questions regarding this wrapper! -

-
-
-
-
-
-
-
- -
-
- - - - \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9691e9b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,75 @@ +# JavaBotBlockAPI +A Java Wrapper for the BotBlock.org API, supporting all API endpoints of it. + +## Javadocs +Below can you find Javadocs for each module. + +- [Core](https://docs.botblock.org/JavaBotBlockAPI/core/) +- [Javacord](https://docs.botblock.org/JavaBotBlockAPI/javacord/org/botblock/javabotblockapi/javacord/package-summary.html) +- [JDA](https://docs.botblock.org/JavaBotBlockAPI/jda/org/botblock/javabotblockapi/jda/package-summary.html) +- [Request](https://docs.botblock.org/JavaBotBlockAPI/request/org/botblock/javabotblockapi/requests/package-summary.html) + +## Installation +Please replace `{version}` with the latest build available on [CodeMC](https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI/). + +### Gradle +```groovy +repositories{ + maven{ url = 'https://repo.codemc.io/repository/maven-public' } +} + +dependencies{ + // The Core and Request modules are always required. + compile group: 'org.botblock', name: 'javabotblockapi-core', version: '{version}' + compile group: 'org.botblock', name: 'javabotblockapi-request', version: '{version}' + + // Javacord module for direct support with Javacord. + compile group: 'org.botblock', name: 'javabotblockapi-javacord', version: '{version}' + + // JDA module for direct support with JDA. + compile group: 'org.botblock', name: 'javabotblockapi-jda', version: '{version}' +} +``` + +### Maven +```xml + + + codemc + https://repo.codemc.io/repository/maven-public/ + + + + + + + org.botblock + javabotblockapi-core + {version} + + + + org.botblock + javabotblockapi-request + {version} + + + + org.botblock + javabotblockapi-javacord + {version} + + + + org.botblock + javabotblockapi-jda + {version} + + +``` + +## Links + +- [BotBlock Documentation](https://botblock.org/docs) +- [BotBlock Discord](https://botblock.org/discord) (**Do NOT ask BotBlock-Staff for help with this API Wrapper**) +- [Andre's Support Discord](https://discord.gg/6dazXp6) (Ask in the `#javabotblockapi` channel) From f7727aad6b218d4f5021ba54acdaa068440a8861 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Fri, 17 Dec 2021 15:55:15 +0100 Subject: [PATCH 2/4] Create gen_javadocs.yml --- .github/workflows/gen_javadocs.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/gen_javadocs.yml diff --git a/.github/workflows/gen_javadocs.yml b/.github/workflows/gen_javadocs.yml new file mode 100644 index 0000000..5f18ded --- /dev/null +++ b/.github/workflows/gen_javadocs.yml @@ -0,0 +1,26 @@ +name: Publication task + +on: + workflow_dispatch: + +jobs: + generateJavadoc: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v2.3.4 + with: + ref: 'master' + - name: Set up Java 11 + uses: actions/setup-java@v2 + with: + distribution: 'temurin' + java-version: '11' + - name: Generate Javadoc + run: ./gradlew javadoc + - name: Push changes + uses: peaceiris/actions-gh-pages@v3.8.0 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs + commit_message: "Update Docs" From 986d7758d11f19ae5c9301fabdbfef4cf1a45dce Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Fri, 17 Dec 2021 15:56:28 +0100 Subject: [PATCH 3/4] Update gen_javadocs.yml --- .github/workflows/gen_javadocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gen_javadocs.yml b/.github/workflows/gen_javadocs.yml index 5f18ded..2082759 100644 --- a/.github/workflows/gen_javadocs.yml +++ b/.github/workflows/gen_javadocs.yml @@ -1,4 +1,4 @@ -name: Publication task +name: Build Javadocs on: workflow_dispatch: From 5a21d3d14822c24aafbe4474f54f7061db4f4b14 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Sat, 18 Dec 2021 15:52:35 +0100 Subject: [PATCH 4/4] Try build with jekyll... --- .github/workflows/gen_javadocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/gen_javadocs.yml b/.github/workflows/gen_javadocs.yml index 2082759..5fb91ee 100644 --- a/.github/workflows/gen_javadocs.yml +++ b/.github/workflows/gen_javadocs.yml @@ -24,3 +24,4 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs commit_message: "Update Docs" + enable_jekyll: true