Initial commit

.github/workflows/deploy.yml

@@ -0,0 +1,64 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+docs/.vitepress/dist
+docs/.vitepress/cache

.vscode/docs.code-snippets

@@ -0,0 +1,122 @@
+{
+  "Class": {
+    "scope": "md,markdown",
+    "prefix": "doc.class",
+    "body": [
+      "---",
+      "title: $0",
+      "---",
+      "",
+      "# $0",
+      "",
+      "## Parameters",
+      "",
+      "| Name       | Type | Description |",
+      "| ---------- | ---- | ----------- |",
+      "| `arg_name` |      |             |",
+      "",
+      "## Methods",
+      "",
+      "- [name](#name)",
+      "",
+      "### name",
+      "",
+      "#### Parameters",
+      "",
+      "| Name   | Type | Description |",
+      "| ------ | ---- | ----------- |",
+      "| `name` |      |             |",
+      "",
+      "## Example",
+      "",
+      "```py",
+      "",
+      "```"
+    ]
+  },
+  "Functions": {
+    "scope": "md,markdown",
+    "prefix": "doc.functions",
+    "body": [
+      "---",
+      "title: Functions",
+      "---",
+      "",
+      "# Functions",
+      "",
+      "- [func](#func)",
+      "",
+      "## func",
+      "### Parameters",
+      "",
+      "| Name       | Type | Description |",
+      "| ---------- | ---- | ----------- |",
+      "| `arg_name` |      |             |",
+      "",
+      "## Example",
+      "",
+      "```py",
+      "",
+      "```"
+    ]
+  },
+  "Undocumented": {
+    "scope": "md,markdown",
+    "prefix": "undocumented",
+    "body": [
+      "---",
+      "title: $0",
+      "---",
+      "",
+      "# $0",
+      "",
+      "undocumented",
+      ""
+    ]
+  },
+  "Info": {
+    "scope": "md,markdown",
+    "prefix": "container.info",
+    "body": [
+      "::: info",
+      "$0",
+      ":::"
+    ]
+  },
+  "Tip": {
+    "scope": "md,markdown",
+    "prefix": "container.tip",
+    "body": [
+      "::: tip",
+      "$0",
+      ":::"
+    ]
+  },
+  "Warning": {
+    "scope": "md,markdown",
+    "prefix": "container.warning",
+    "body": [
+      "::: warning",
+      "$0",
+      ":::"
+    ]
+  },
+  "Danger": {
+    "scope": "md,markdown",
+    "prefix": "container.danger",
+    "body": [
+      "::: danger",
+      "$0",
+      ":::"
+    ]
+  },
+  "Details": {
+    "scope": "md,markdown",
+    "prefix": "container.details",
+    "body": [
+      "::: details",
+      "$0",
+      ":::"
+    ]
+  },
+}

TODO.md

@@ -0,0 +1,7 @@
+# TODO
+
+- https://docs.lpsmods.dev/morefood/americano
+
+- rewrite classes to be like the snippet
+- Add docs for mcaddon
+- CLI docs should be something like https://vitepress.dev/reference/cli

docs/.htaccess

@@ -0,0 +1,3 @@
+RewriteEngine On
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^([^\.]+)$ $1.html [NC,L]