diff options
| -rw-r--r-- | .github/workflows/build-docs.yml | 76 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | Writerside/topics/introduction.md | 2 | ||||
| -rw-r--r-- | Writerside/writerside.cfg | 2 |
4 files changed, 80 insertions, 2 deletions
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
@@ -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 @@ <ihp version="2.0"> <topics dir="topics" web-path="topics"/> <images dir="images" web-path="images"/> - <instance src="md.tree" web-path="molehunt/" version="1.1.0"/> + <instance src="md.tree" web-path="molehunt" version="1.1.0"/> </ihp>
\ No newline at end of file |