docs: set up mdbook

.github/workflows/gh-pages.yml

@@ -0,0 +1,54 @@
+name: Github Pages
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+  workflow_dispatch:
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: 'latest'
+
+      - run: mdbook build book
+
+  deploy:
+    environment:
+      name: gh-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs: build
+    steps:
+      - name: Set output directory
+        run: |
+          OUTDIR=$(basename ${{ github.ref }})
+          echo "OUTDIR=$OUTDIR" >> $GITHUB_ENV
+
+      - name: Deploy stable
+        uses: peaceiris/actions-gh-pages@v4
+        if: startswith(github.ref, 'refs/tags/')
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/book
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/book
+          destination_dir: ./${{ env.OUTDIR }}

book/.gitignore

@@ -0,0 +1 @@
+book

book/book.toml

@@ -0,0 +1,17 @@
+[book]
+authors = ["Adam Perkowski"]
+language = "en"
+multilingual = false
+src = "src"
+title = "HighlightOS"
+
+[output.html]
+cname = "os.adamperkowski.dev"
+#default-theme = "colibri"
+#preferred-dark-theme = "colibri"
+git-repository-url = "https://github.com/adamperkowski/highlightos"
+edit-url-template = "https://github.com/adamperkowski/highlightos/edit/master/book/{path}"
+#additional-css = ["custom.css"]
+
+[output.html.search]
+use-boolean-and = true

book/src/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [HighlightOS](./highlightos.md)

book/src/highlightos.md

@@ -0,0 +1,5 @@
+# HighlightOS
+
+x86_64 OS (kernel) made completely from scratch in Assembly & Rust
+
+Documentation for bleeding-edge main can be found at [https://os.adamperkowski.dev/main](https://os.adamperkowski.dev/main).