From 0251bb2b7f51c71ab749a7a95a8e28d5eeaf2139 Mon Sep 17 00:00:00 2001 From: Putta Khunchalee Date: Tue, 12 Nov 2024 16:23:38 +0700 Subject: [PATCH] Adds MkDocs --- .github/workflows/gh-pages.yml | 10 +++++-- .gitignore | 28 +----------------- README.md | 17 +++++++++-- mkdocs.yml | 5 ++++ src/index.md | 0 {src => theme}/.nojekyll | 0 {src => theme}/_errorPages/403.html | 0 {src => theme}/_errorPages/404.html | 0 {src => theme}/_errorPages/500.html | 0 {src => theme}/_errorPages/errapp.js | 0 {src => theme}/_errorPages/errstyles.css | 0 .../_images/Obliteration-smoll.avif | Bin {src => theme}/_images/Obliteration-smoll.png | Bin {src => theme}/_images/Obliteration.avif | Bin {src => theme}/_images/Obliteration.png | Bin {src => theme}/_images/arrow_forward.svg | 0 {src => theme}/_images/close.svg | 0 {src => theme}/_images/discord.svg | 0 {src => theme}/_images/github.svg | 0 {src => theme}/_images/menu.svg | 0 .../_images/obliteration-screenshots.png | Bin {src => theme}/app.js | 0 {src => theme}/compatibility/app.js | 0 {src => theme}/compatibility/index.html | 0 {src => theme}/compatibility/styles.css | 0 {src => theme}/download/_images/linux.svg | 0 {src => theme}/download/_images/macos.svg | 0 .../_images/obliteration-linux-screenshot.png | Bin .../_images/obliteration-macos-screenshot.png | Bin .../obliteration-windows-screenshot.png | Bin {src => theme}/download/_images/warning.svg | 0 {src => theme}/download/_images/windows.svg | 0 {src => theme}/download/app.js | 0 {src => theme}/download/index.html | 0 {src => theme}/download/styles.css | 0 src/index.html => theme/main.html | 0 {src => theme}/required.css | 0 {src => theme}/required.js | 0 {src => theme}/styles.css | 0 39 files changed, 29 insertions(+), 31 deletions(-) create mode 100644 mkdocs.yml create mode 100644 src/index.md rename {src => theme}/.nojekyll (100%) rename {src => theme}/_errorPages/403.html (100%) rename {src => theme}/_errorPages/404.html (100%) rename {src => theme}/_errorPages/500.html (100%) rename {src => theme}/_errorPages/errapp.js (100%) rename {src => theme}/_errorPages/errstyles.css (100%) rename {src => theme}/_images/Obliteration-smoll.avif (100%) rename {src => theme}/_images/Obliteration-smoll.png (100%) rename {src => theme}/_images/Obliteration.avif (100%) rename {src => theme}/_images/Obliteration.png (100%) rename {src => theme}/_images/arrow_forward.svg (100%) rename {src => theme}/_images/close.svg (100%) rename {src => theme}/_images/discord.svg (100%) rename {src => theme}/_images/github.svg (100%) rename {src => theme}/_images/menu.svg (100%) rename {src => theme}/_images/obliteration-screenshots.png (100%) rename {src => theme}/app.js (100%) rename {src => theme}/compatibility/app.js (100%) rename {src => theme}/compatibility/index.html (100%) rename {src => theme}/compatibility/styles.css (100%) rename {src => theme}/download/_images/linux.svg (100%) rename {src => theme}/download/_images/macos.svg (100%) rename {src => theme}/download/_images/obliteration-linux-screenshot.png (100%) rename {src => theme}/download/_images/obliteration-macos-screenshot.png (100%) rename {src => theme}/download/_images/obliteration-windows-screenshot.png (100%) rename {src => theme}/download/_images/warning.svg (100%) rename {src => theme}/download/_images/windows.svg (100%) rename {src => theme}/download/app.js (100%) rename {src => theme}/download/index.html (100%) rename {src => theme}/download/styles.css (100%) rename src/index.html => theme/main.html (100%) mode change 100755 => 100644 rename {src => theme}/required.css (100%) rename {src => theme}/required.js (100%) rename {src => theme}/styles.css (100%) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index a33facd..b249680 100644 --- 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/upload-pages-artifact@v3.0.1 with: - path: src + path: site deploy: name: Deploy runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index 67ea46f..c9490a5 100644 --- 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 \ No newline at end of file +/site diff --git a/README.md b/README.md index fd0ccf2..10f903f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ -# Obliteration.net +# obliteration.net -The website for Obliteration \ No newline at end of file +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 new file mode 100644 index 0000000..065e6ce --- /dev/null +++ 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 new file mode 100644 index 0000000..e69de29 diff --git a/src/.nojekyll b/theme/.nojekyll similarity index 100% rename from src/.nojekyll rename to theme/.nojekyll diff --git a/src/_errorPages/403.html b/theme/_errorPages/403.html similarity index 100% rename from src/_errorPages/403.html rename to theme/_errorPages/403.html diff --git a/src/_errorPages/404.html b/theme/_errorPages/404.html similarity index 100% rename from src/_errorPages/404.html rename to theme/_errorPages/404.html diff --git a/src/_errorPages/500.html b/theme/_errorPages/500.html similarity index 100% rename from src/_errorPages/500.html rename to theme/_errorPages/500.html diff --git a/src/_errorPages/errapp.js b/theme/_errorPages/errapp.js similarity index 100% rename from src/_errorPages/errapp.js rename to theme/_errorPages/errapp.js diff --git a/src/_errorPages/errstyles.css b/theme/_errorPages/errstyles.css similarity index 100% rename from src/_errorPages/errstyles.css rename to theme/_errorPages/errstyles.css diff --git a/src/_images/Obliteration-smoll.avif b/theme/_images/Obliteration-smoll.avif similarity index 100% rename from src/_images/Obliteration-smoll.avif rename to theme/_images/Obliteration-smoll.avif diff --git a/src/_images/Obliteration-smoll.png b/theme/_images/Obliteration-smoll.png similarity index 100% rename from src/_images/Obliteration-smoll.png rename to theme/_images/Obliteration-smoll.png diff --git a/src/_images/Obliteration.avif b/theme/_images/Obliteration.avif similarity index 100% rename from src/_images/Obliteration.avif rename to theme/_images/Obliteration.avif diff --git a/src/_images/Obliteration.png b/theme/_images/Obliteration.png similarity index 100% rename from src/_images/Obliteration.png rename to theme/_images/Obliteration.png diff --git a/src/_images/arrow_forward.svg b/theme/_images/arrow_forward.svg similarity index 100% rename from src/_images/arrow_forward.svg rename to theme/_images/arrow_forward.svg diff --git a/src/_images/close.svg b/theme/_images/close.svg similarity index 100% rename from src/_images/close.svg rename to theme/_images/close.svg diff --git a/src/_images/discord.svg b/theme/_images/discord.svg similarity index 100% rename from src/_images/discord.svg rename to theme/_images/discord.svg diff --git a/src/_images/github.svg b/theme/_images/github.svg similarity index 100% rename from src/_images/github.svg rename to theme/_images/github.svg diff --git a/src/_images/menu.svg b/theme/_images/menu.svg similarity index 100% rename from src/_images/menu.svg rename to theme/_images/menu.svg diff --git a/src/_images/obliteration-screenshots.png b/theme/_images/obliteration-screenshots.png similarity index 100% rename from src/_images/obliteration-screenshots.png rename to theme/_images/obliteration-screenshots.png diff --git a/src/app.js b/theme/app.js similarity index 100% rename from src/app.js rename to theme/app.js diff --git a/src/compatibility/app.js b/theme/compatibility/app.js similarity index 100% rename from src/compatibility/app.js rename to theme/compatibility/app.js diff --git a/src/compatibility/index.html b/theme/compatibility/index.html similarity index 100% rename from src/compatibility/index.html rename to theme/compatibility/index.html diff --git a/src/compatibility/styles.css b/theme/compatibility/styles.css similarity index 100% rename from src/compatibility/styles.css rename to theme/compatibility/styles.css diff --git a/src/download/_images/linux.svg b/theme/download/_images/linux.svg similarity index 100% rename from src/download/_images/linux.svg rename to theme/download/_images/linux.svg diff --git a/src/download/_images/macos.svg b/theme/download/_images/macos.svg similarity index 100% rename from src/download/_images/macos.svg rename to theme/download/_images/macos.svg diff --git a/src/download/_images/obliteration-linux-screenshot.png b/theme/download/_images/obliteration-linux-screenshot.png similarity index 100% rename from src/download/_images/obliteration-linux-screenshot.png rename to theme/download/_images/obliteration-linux-screenshot.png diff --git a/src/download/_images/obliteration-macos-screenshot.png b/theme/download/_images/obliteration-macos-screenshot.png similarity index 100% rename from src/download/_images/obliteration-macos-screenshot.png rename to theme/download/_images/obliteration-macos-screenshot.png diff --git a/src/download/_images/obliteration-windows-screenshot.png b/theme/download/_images/obliteration-windows-screenshot.png similarity index 100% rename from src/download/_images/obliteration-windows-screenshot.png rename to theme/download/_images/obliteration-windows-screenshot.png diff --git a/src/download/_images/warning.svg b/theme/download/_images/warning.svg similarity index 100% rename from src/download/_images/warning.svg rename to theme/download/_images/warning.svg diff --git a/src/download/_images/windows.svg b/theme/download/_images/windows.svg similarity index 100% rename from src/download/_images/windows.svg rename to theme/download/_images/windows.svg diff --git a/src/download/app.js b/theme/download/app.js similarity index 100% rename from src/download/app.js rename to theme/download/app.js diff --git a/src/download/index.html b/theme/download/index.html similarity index 100% rename from src/download/index.html rename to theme/download/index.html diff --git a/src/download/styles.css b/theme/download/styles.css similarity index 100% rename from src/download/styles.css rename to theme/download/styles.css diff --git a/src/index.html b/theme/main.html old mode 100755 new mode 100644 similarity index 100% rename from src/index.html rename to theme/main.html diff --git a/src/required.css b/theme/required.css similarity index 100% rename from src/required.css rename to theme/required.css diff --git a/src/required.js b/theme/required.js similarity index 100% rename from src/required.js rename to theme/required.js diff --git a/src/styles.css b/theme/styles.css similarity index 100% rename from src/styles.css rename to theme/styles.css