Rebuild docs site on Astro Starlight

.cspell-words.txt

@@ -0,0 +1,183 @@
+AbstractMenus
+HOCON
+Spigot
+Bukkit
+Paper
+Folia
+Minecraft
+PlaceholderAPI
+LuckPerms
+WorldGuard
+SkinsRestorer
+MMOItems
+HeadDatabase
+ItemsAdder
+Oraxen
+Citizens
+Vault
+SpigotMC
+Mythic
+MythicLib
+PaperMC
+SpigotAPI
+papermc
+mvn
+gradlew
+groovyId
+artifactId
+prerelease
+servlet
+JitPack
+Pagefind
+Starlight
+mdx
+mdxjs
+shiki
+TextMate
+texlive
+pygments
+sphinx
+gettext
+sphinx-intl
+unmaintained
+linkcards
+toctree
+admonitions
+admonition
+serializer
+serializers
+deserialize
+deserializing
+denyActions
+takeMoney
+giveMoney
+itemAdd
+openMenu
+mymenu
+skullOwner
+mmoitem
+hdb
+papi
+namespaced
+varp
+configs
+unbreakable
+gamemode
+unhighlighted
+substitutions
+multiline
+substituted
+prepend
+prepends
+prepending
+favicon
+schemastore
+remark
+rehype
+typesafe
+stdin
+stdout
+SQLite
+NMS
+Javadoc
+Javadocs
+preffered
+donwload
+strigns
+lightbend
+codecov
+htmlproofer
+lychee
+htmlencoder
+checksum
+multiplatform
+overscan
+crossplatform
+overengineering
+unprefixed
+backslash
+substring
+fullwidth
+WebAssembly
+Codemirror
+Monaco
+JsonLexer
+HoconLexer
+overengineered
+hyperlink
+hyperlinks
+PaperWeight
+ProGuard
+foliaLib
+adventure
+luckperms
+worldguard
+skinsrestorer
+itemsadder
+oraxen
+citizens
+boilerplate
+boilerplates
+deprecations
+RTD
+URLs
+APIs
+SDKs
+IDEs
+IDE
+IntelliJ
+IntelliJIDEA
+gh-pages
+prerendered
+SSR
+SSG
+RSS
+oss
+boolean
+booleans
+filesystem
+multiroot
+postcss
+TextMate
+boolean
+substring
+substitutions
+intermediates
+intermediates
+
+# Project author / proper nouns
+Nanit
+Nashorn
+Deutsch
+
+# AbstractMenus-specific HOCON keys / placeholders
+hanim
+mrules
+vart
+varpt
+itemstack
+actionbar
+classloader
+Cheatsheet
+Cooldown
+cooldown
+cooldowns
+Frontmatter
+
+# Common technical English not in default dict
+interactable
+pickable
+respawn
+respawning
+laggy
+topo
+
+# British English (project preference)
+behaviour
+colour
+recognised
+customisation
+customises
+organisation
+JDBC
+JPMS

.cspell.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "language": "en",
+  "ignorePaths": [
+    "node_modules",
+    "dist",
+    ".astro",
+    "package-lock.json",
+    "src/grammars",
+    "src/content/docs/ru/**"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "project-terms",
+      "path": ".cspell-words.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["project-terms"],
+  "ignoreRegExpList": [
+    "/`[^`]*`/g",
+    "/```[\\s\\S]*?```/g",
+    "/https?:\\/\\/\\S+/g",
+    "/\\$\\{[^}]*\\}/g",
+    "/<[A-Za-z][^>]*>/g"
+  ]
+}

.github/workflows/deploy.yml

@@ -0,0 +1,44 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+
+      - run: npm ci
+
+      - run: npm run build
+
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: dist
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-24.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Lint docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  spell:
+    name: cspell
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+      - uses: streetsidesoftware/cspell-action@v6
+        with:
+          files: |
+            src/content/**/*.{md,mdx}
+            README.md
+          inline: warning
+          incremental_files_only: false
+
+  markdown:
+    name: markdownlint
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+      - uses: DavidAnson/markdownlint-cli2-action@v20
+        with:
+          globs: |
+            src/content/**/*.{md,mdx}
+            README.md

.github/workflows/lychee.yml

@@ -0,0 +1,47 @@
+name: Link check
+
+on:
+  schedule:
+    # Mondays 06:00 UTC
+    - cron: "0 6 * * 1"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  issues: write
+
+jobs:
+  lychee:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v5
+        with:
+          node-version: 22
+          cache: npm
+
+      - run: npm ci
+      - run: npm run build
+
+      - name: Run Lychee
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: >-
+            --no-progress
+            --accept 200,204,206,301,302,308,403,429
+            --exclude-mail
+            --exclude-path dist/_astro
+            --exclude-path dist/pagefind
+            --max-concurrency 8
+            './dist/**/*.html'
+          fail: false
+
+      - name: File issue from report
+        if: env.lychee_exit_code != '0'
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: "Link check report ${{ github.run_id }}"
+          content-filepath: ./lychee/out.md
+          labels: docs, link-check

.gitignore

@@ -1 +1,15 @@
-_build
+# Astro / Node build output
+dist/
+.astro/
+node_modules/
+
+# Editor / OS
+.idea/
+.DS_Store
+.vscode/
+*.log
+
+# Env
+.env
+.env.*
+!.env.example