init mdbook

Signed-off-by: Ryan Brue <ryanbrue.dev@gmail.com>
ryanabx · Sep 17, 2024 · f5e4408 · f5e4408
1 parent c73eb17
commit f5e4408
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 29 deletions.
diff --git a/.github/workflows/build_website.yml b/.github/workflows/build_website.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,29 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: 'latest'
+
+      - run: mdbook build docs
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/book.toml b/docs/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Ryan Brue"]
+language = "en"
+multilingual = false
+src = "src"
+title = "rbshell - A wayland shell"
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -0,0 +1,4 @@
+# Summary
+
+- [Introduction](./index.md)
+- [Building and testing](./building-and-testing.md)
diff --git a/docs/building-and-testing.md → docs/src/building-and-testing.md b/docs/building-and-testing.md → docs/src/building-and-testing.md
diff --git a/docs/index.md → docs/src/index.md b/docs/index.md → docs/src/index.md