Skip to content

Commit

Permalink
[docs only] Document counters
Browse files Browse the repository at this point in the history
  • Loading branch information
Matyrobbrt committed Aug 8, 2024
1 parent 40ebbf5 commit 9dac278
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/publish_ghcr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:

jobs:
push-image:
if: !contains(github.event.head_commit.message, '[docs only]')
runs-on: ubuntu-latest
steps:
- name: 'Checkout GitHub Action'
Expand All @@ -33,4 +34,4 @@ jobs:
run: |
docker build . --tag ghcr.io/neoforged/camelot:latest --tag ghcr.io/neoforged/camelot:${{ env.BOT_VERSION }}
docker push ghcr.io/neoforged/camelot:latest
docker push ghcr.io/neoforged/camelot:${{ env.BOT_VERSION }}
docker push ghcr.io/neoforged/camelot:${{ env.BOT_VERSION }}
1 change: 1 addition & 0 deletions .github/workflows/publish_maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:

jobs:
publish:
if: !contains(github.event.head_commit.message, '[docs only]')
runs-on: ubuntu-latest
steps:
- name: 'Checkout GitHub Action'
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ export default defineUserConfig({
{
text: 'Moderation',
link: '/modules/moderation'
},
{
text: 'Counters',
link: '/modules/counters'
}
]
}
Expand Down
7 changes: 7 additions & 0 deletions docs/docs/modules/counters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Counters Module
The counters module (id: `counters`, configuration class: `Counters`) provides users the ability to increment counters (integers) in chat:
- `<counter>++`: increments a counter by 1
- `<counter>--`: decrements a counter by 1
- `<counter>==`: gets a counter's value

For instance, `derps++` increments the value of the `derps` counter by 1.
2 changes: 1 addition & 1 deletion docs/docs/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Camelot features are grouped in modules that can be enabled and configured separately.

By default, the following modules are enabled:
- Counters
- [Counters](./counters)
- Custom Pings
- File Preview (must have a PAT configured to work)
- Info Channels (must have a PAT configured to work)
Expand Down

0 comments on commit 9dac278

Please sign in to comment.