Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/deploy-wiki.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy wiki

on:
push:
branches: [main, master]
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/deploy-wiki.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- run: pip install mkdocs-material
- uses: actions/configure-pages@v5
- run: mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4
32 changes: 0 additions & 32 deletions .github/workflows/wiki-sync.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Package root: `astro.tjm` (mod id `tjm`). Entrypoints are declared in `fabric.mo
Code driven: use the `minecraft:impossible` trigger and call `award(player, world, "<name>", "<criterion>")` from an event in `TheJourneyMatters`.

## Build
`./gradlew build` (JDK 25). See [[Contributing]].
`./gradlew build` (JDK 25). See [Contributing](Contributing.md).
2 changes: 1 addition & 1 deletion docs/wiki/Contributing.md → docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
5. `./gradlew javadoc` – generate API docs.

## Docs
Wiki pages live in `docs/wiki/` in the main repo. Edit them via pull request; the `Wiki sync` workflow publishes them to the GitHub Wiki on merge to `master`. Do not edit the wiki directly, as changes will be overwritten.
Wiki pages live in `docs/` in the main repo and are built with MkDocs. Edit them via pull request; the `Deploy wiki` workflow publishes them to GitHub Pages on merge to `master`.
2 changes: 1 addition & 1 deletion docs/wiki/Game-Mechanics.md → docs/Game-Mechanics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The root advancement `tjm:root` ("The Journey Matters", bedrock icon) creates th
| The First of Its Kind | `tjm:adventure/first_of_its_kind` | Bone | Have your tamed wolf kill a mob in the Nether. |
| The Grocer | `tjm:adventure/the_grocer` | Emerald | Trade with a villager of every profession (13 criteria, all required). |

All three use the "goal" frame and grant no rewards. `nether_roof` and `first_of_its_kind` use the `minecraft:impossible` trigger and are awarded from code (see [[Code Documentation|Code-Documentation]]). `the_grocer` is fully data driven.
All three use the "goal" frame and grant no rewards. `nether_roof` and `first_of_its_kind` use the `minecraft:impossible` trigger and are awarded from code (see [Code Documentation](Code-Documentation.md)). `the_grocer` is fully data driven.

Villager professions required: armorer, butcher, cartographer, cleric, farmer, fisherman, fletcher, leatherworker, librarian, mason, shepherd, toolsmith, weaponsmith.

Expand Down
6 changes: 3 additions & 3 deletions docs/wiki/Home.md → docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ A Fabric mod that adds a custom **Journey** advancement tab and a few Nether rul
3. Start the game.

## Pages
- [[Game Mechanics|Game-Mechanics]]
- [[Code Documentation|Code-Documentation]]
- [[Contributing]]
- [Game Mechanics](Game-Mechanics.md)
- [Code Documentation](Code-Documentation.md)
- [Contributing](Contributing.md)
4 changes: 0 additions & 4 deletions docs/wiki/_Sidebar.md

This file was deleted.

36 changes: 36 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
site_name: TJM – The Journey Matters
site_description: Documentation for the TJM Fabric mod
repo_url: https://github.com/JannisHeydemann/TJM
docs_dir: docs
theme:
name: material
features:
- search.suggest
- search.highlight
- navigation.instant
- navigation.top
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
plugins:
- search
markdown_extensions:
- admonition
- toc:
permalink: true
- pymdownx.highlight
- pymdownx.superfences
nav:
- Home: index.md
- Game Mechanics: Game-Mechanics.md
- Code Documentation: Code-Documentation.md
- Contributing: Contributing.md
Loading