Adds MkDocs

Author: ultimaweapon

.github/workflows/gh-pages.yml

@@ -6,14 +6,20 @@ on:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
+    - name: Install system packages
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y mkdocs-material
+    - name: Build
+      run: mkdocs build
     - name: Upload artifacts
       uses: actions/[email protected]
       with:
-        path: src
+        path: site
   deploy:
     name: Deploy
     runs-on: ubuntu-latest

.gitignore

@@ -1,27 +1 @@
-# ---> Rust
-# Generated by Cargo
-# will have compiled files and executables
-debug/
-target/
-Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
-
-# MSVC Windows builds of rustc generate these, which store debugging information
-*.pdb
-
-.vscode
-stuff.txt
-.idea
-*.db
-.htaccess
-
-mdbook/book/
-updater/images/
-/public_html/Gamma-Boi/compatibility/_images/games/
-/public_html/Gamma-Boi/compatibility/_images/hb/
-
-stats.json
-database.json
-game_skips.json
+/site

README.md

@@ -1,3 +1,16 @@
-# Obliteration.net
+# obliteration.net
 
-The website for Obliteration
+The website for Obliteration.
+
+## Development
+
+### Prerequisites
+
+- [MkDocs](https://www.mkdocs.org)
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material)
+
+### Start development server
+
+```sh
+mkdocs serve
+```

mkdocs.yml

@@ -0,0 +1,5 @@
+site_name: Obliteration
+docs_dir: src
+theme:
+  name: material
+  custom_dir: theme