Adds MkDocs

obhq · Nov 12, 2024 · 0251bb2 · 0251bb2
1 parent 3fed963
commit 0251bb2
Show file tree

Hide file tree

Showing 39 changed files with 29 additions and 31 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.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

diff --git a/.gitignore b/.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
diff --git a/README.md b/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
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,5 @@
+site_name: Obliteration
+docs_dir: src
+theme:
+  name: material
+  custom_dir: theme
diff --git a/src/index.md b/src/index.md
diff --git a/src/.nojekyll → theme/.nojekyll b/src/.nojekyll → theme/.nojekyll
diff --git a/src/_errorPages/403.html → theme/_errorPages/403.html b/src/_errorPages/403.html → theme/_errorPages/403.html
diff --git a/src/_errorPages/404.html → theme/_errorPages/404.html b/src/_errorPages/404.html → theme/_errorPages/404.html
diff --git a/src/_errorPages/500.html → theme/_errorPages/500.html b/src/_errorPages/500.html → theme/_errorPages/500.html
diff --git a/src/_errorPages/errapp.js → theme/_errorPages/errapp.js b/src/_errorPages/errapp.js → theme/_errorPages/errapp.js
diff --git a/src/_errorPages/errstyles.css → theme/_errorPages/errstyles.css b/src/_errorPages/errstyles.css → theme/_errorPages/errstyles.css
diff --git a/src/_images/Obliteration-smoll.avif → theme/_images/Obliteration-smoll.avif b/src/_images/Obliteration-smoll.avif → theme/_images/Obliteration-smoll.avif
diff --git a/src/_images/Obliteration-smoll.png → theme/_images/Obliteration-smoll.png b/src/_images/Obliteration-smoll.png → theme/_images/Obliteration-smoll.png
diff --git a/src/_images/Obliteration.avif → theme/_images/Obliteration.avif b/src/_images/Obliteration.avif → theme/_images/Obliteration.avif
diff --git a/src/_images/Obliteration.png → theme/_images/Obliteration.png b/src/_images/Obliteration.png → theme/_images/Obliteration.png
diff --git a/src/_images/arrow_forward.svg → theme/_images/arrow_forward.svg b/src/_images/arrow_forward.svg → theme/_images/arrow_forward.svg
diff --git a/src/_images/close.svg → theme/_images/close.svg b/src/_images/close.svg → theme/_images/close.svg
diff --git a/src/_images/discord.svg → theme/_images/discord.svg b/src/_images/discord.svg → theme/_images/discord.svg
diff --git a/src/_images/github.svg → theme/_images/github.svg b/src/_images/github.svg → theme/_images/github.svg
diff --git a/src/_images/menu.svg → theme/_images/menu.svg b/src/_images/menu.svg → theme/_images/menu.svg
diff --git a/src/_images/obliteration-screenshots.png → theme/_images/obliteration-screenshots.png b/src/_images/obliteration-screenshots.png → theme/_images/obliteration-screenshots.png
diff --git a/src/app.js → theme/app.js b/src/app.js → theme/app.js
diff --git a/src/compatibility/app.js → theme/compatibility/app.js b/src/compatibility/app.js → theme/compatibility/app.js
diff --git a/src/compatibility/index.html → theme/compatibility/index.html b/src/compatibility/index.html → theme/compatibility/index.html
diff --git a/src/compatibility/styles.css → theme/compatibility/styles.css b/src/compatibility/styles.css → theme/compatibility/styles.css
diff --git a/src/download/_images/linux.svg → theme/download/_images/linux.svg b/src/download/_images/linux.svg → theme/download/_images/linux.svg
diff --git a/src/download/_images/macos.svg → theme/download/_images/macos.svg b/src/download/_images/macos.svg → theme/download/_images/macos.svg
diff --git a/..._images/obliteration-linux-screenshot.png → ..._images/obliteration-linux-screenshot.png b/..._images/obliteration-linux-screenshot.png → ..._images/obliteration-linux-screenshot.png
diff --git a/..._images/obliteration-macos-screenshot.png → ..._images/obliteration-macos-screenshot.png b/..._images/obliteration-macos-screenshot.png → ..._images/obliteration-macos-screenshot.png
diff --git a/...mages/obliteration-windows-screenshot.png → ...mages/obliteration-windows-screenshot.png b/...mages/obliteration-windows-screenshot.png → ...mages/obliteration-windows-screenshot.png
diff --git a/src/download/_images/warning.svg → theme/download/_images/warning.svg b/src/download/_images/warning.svg → theme/download/_images/warning.svg
diff --git a/src/download/_images/windows.svg → theme/download/_images/windows.svg b/src/download/_images/windows.svg → theme/download/_images/windows.svg
diff --git a/src/download/app.js → theme/download/app.js b/src/download/app.js → theme/download/app.js
diff --git a/src/download/index.html → theme/download/index.html b/src/download/index.html → theme/download/index.html
diff --git a/src/download/styles.css → theme/download/styles.css b/src/download/styles.css → theme/download/styles.css
diff --git a/src/index.html → theme/main.html b/src/index.html → theme/main.html
diff --git a/src/required.css → theme/required.css b/src/required.css → theme/required.css
diff --git a/src/required.js → theme/required.js b/src/required.js → theme/required.js
diff --git a/src/styles.css → theme/styles.css b/src/styles.css → theme/styles.css