working on documentation overhaul

.forgejo/workflows/docs.yaml

@@ -0,0 +1,51 @@
+name: Build Documentation
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request:
+
+jobs:
+  Build Documentation:
+    runs-on: docker
+    container: catthehacker/ubuntu:act-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: poetry install --with docs --no-root
+
+      - name: Set environment variables
+        uses: actions/env@v2
+
+      - name: Build documentation
+        run: |
+          export SITE_URL="https://$CI_ACTION_REF_NAME_SLUG.docs.galacticfactory.cc"
+          export EDIT_URI="src/branch/$CI_ACTION_REF_NAME/docs"
+          mkdocs build -v
+
+      - name: Deploy documentation
+        run: |
+          GREEN='\033[0;32m'
+          YELLOW='\033[0;33m'
+          BLUE='\033[0;34m'
+
+          unset GITHUB_TOKEN
+          unset GITLAB_TOKEN
+
+          echo "${YELLOW}Deploying to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}...\n"
+
+          npx -p "@getmeli/cli" meli upload ./site \
+            --url "https://pages.coastalcommits.com" \
+            --site "${{ vars.MELI_SITE_ID }}" \
+            --token "${{ secrets.MELI_SITE_SECRET }}" \
+            --release "$CI_ACTION_REF_NAME_SLUG/${{ env.GITHUB_SHA }}" \
+            --branch "$CI_ACTION_REF_NAME_SLUG"
+
+          echo "\n${YELLOW}Deployed to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}!"
+          echo "${GREEN}https://$CI_ACTION_REF_NAME_SLUG.docs.galacticfactory.cc/"
+        env:
+          GITEA_TOKEN: ${{ secrets.COASTALCOMMITSTOKEN }}

docs/index.md

@@ -0,0 +1 @@
+# Hello

mkdocs.yml

@@ -0,0 +1,80 @@
+site_name: GalacticFactory Documentation
+site_url: !ENV [SITE_URL, 'https://docs.galacticfactory.cc']
+repo_name: CoastalCommits
+repo_url: https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
+edit_uri: !ENV [EDIT_URI, 'src/branch/main/docs']
+copyright: Copyright © 2023-2024, GalacticFactory
+docs_dir: docs
+
+site_author: GalacticFactory
+site_description: Documentation for the GalacticFactory modpack.
+
+nav:
+  - Home: index.md
+
+plugins:
+  - git-authors
+  - search
+  #- social
+  - git-revision-date-localized:
+      enable_creation_date: true
+      type: timeago
+
+markdown_extensions:
+  - abbr
+  - attr_list
+  - md_in_html
+  - tables
+  - pymdownx.blocks.details
+  - pymdownx.blocks.admonition
+  - pymdownx.saneheaders
+  - pymdownx.magiclink
+  - pymdownx.mark
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+
+theme:
+  name: material
+  palette:
+    - media: '(prefers-color-scheme: light)'
+      scheme: default
+      primary: white
+      accent: light blue
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to dark mode
+
+    - media: '(prefers-color-scheme: dark)'
+      scheme: slate
+      primary: black
+      accent: light blue
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to light mode
+  features:
+    - announce.dismiss
+    - content.code.annotate
+    - content.code.copy
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tabs
+    - navigation.tracking
+    - navigation.top
+    - navigation.sections
+    - navigation.indexes
+    - search.suggest
+    - search.highlight
+    - search.share
+    - toc.follow
+  logo: img/logo.png
+  favicon: img/logo.png
+  icon:
+    repo: simple/forgejo

pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "galacticfactory-docs"
+version = "0.1.0"
+description = "Documentation for the GalacticFactory modpack"
+authors = ["GalacticFactory <contact@galacticfactory.cc>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.11"
+mkdocs = "1.5.3"
+mkdocs-git-authors-plugin = "0.7.2"
+mkdocs-git-revision-date-localized-plugin = "1.2.2"
+mkdocs-material = {extras = ["imaging"], version = "^9.5.2"}
+mkdocs-redirects = "^1.2.1"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"