From 1e42af1d9ac1e0bc7d26c8323272fd6a32e3c400 Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 17:18:05 +0000 Subject: ci(actions): build and publish wiki to github pages --- .github/workflows/build-docs.yml | 76 +++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ Writerside/topics/introduction.md | 2 +- Writerside/writerside.cfg | 2 +- 4 files changed, 80 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..efd7cb3 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,76 @@ +name: Build documentation + +on: + push: + branches: ["main"] + workflow_dispatch: + +env: + INSTANCE: 'Writerside/md' + ARTIFACT: 'webHelpMD2-all.zip' + DOCKER_VERSION: '241.18775' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build docs using Writerside Docker builder + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Save artifact with build results + uses: actions/upload-artifact@v4 + with: + name: docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + test: + needs: build + runs-on: ubuntu-latest + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: [build, test] + runs-on: ubuntu-latest + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Package and upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index f739a69..b81628c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Molehunt is a Minecraft mod creating the game with the same name in this cubic game. +A complete wiki is available [here](https://www.anhgelus.world/molehunt/). + ## Usage Install the mod on the server and on all clients. diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index 78749be..3311fd0 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -1,6 +1,6 @@ # Introduction -Molehunt is a mod creating the Molehunt game in Minecraft. +[Molehunt](https://modrinth.com/mod/molehunt-mod) is a mod creating the Molehunt game in Minecraft. You can watch this [video](https://www.youtube.com/watch?v=NJBjQ8T_1cc) to understand what it is. If you are speaking French, I realized this [30 seconds video](https://cdn.anhgelus.world/molehunt-presentation.mp4) explaining the concept. diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg index c8afa7c..1e00bbe 100644 --- a/Writerside/writerside.cfg +++ b/Writerside/writerside.cfg @@ -4,5 +4,5 @@ - + \ No newline at end of file -- cgit v1.2.3