Replace mkdocs with mdbook

Author: yukibtc

.github/workflows/book.yml

@@ -6,35 +6,21 @@ on:
       - 'book/**'
   workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
+  contents: write
+  actions: read
 
 jobs:
   deploy:
     name: Deploy book
     if: github.ref == 'refs/heads/master'
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Set Up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.12'
-
       - name: Init
         run: cd book && make init
 
@@ -44,11 +30,9 @@ jobs:
       - name: Setup Pages
         uses: actions/configure-pages@v4
 
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/master' }}
         with:
-          path: './book/site'
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v3
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/book

Cargo.toml

@@ -2,7 +2,8 @@
 members = [
     "bindings/*",
     "crates/*",
-    "crates/nostr-database/fuzz/perf"
+    "crates/nostr-database/fuzz/perf",
+    "book/snippets/nostr/rust",
 ]
 default-members = ["crates/*"]
 resolver = "2"

book/.gitignore

@@ -1,2 +1 @@
-site/
-poetry.lock
+book

book/Makefile

@@ -1,9 +1,9 @@
 init:
-	pip install -U poetry
-	poetry install
+	cargo install mdbook --version 0.4.36
+	cargo install mdbook-admonish --version 1.15.0
 
 build:
-	poetry run mkdocs build --strict --clean --verbose
+	mdbook build
 
 serve:
-	mkdocs serve
+	mdbook serve

book/book.toml

@@ -0,0 +1,19 @@
+[book]
+title = "Rust Nostr Book"
+description = ""
+authors = ["Yuki Kishimoto <[email protected]>", "Rust Nostr Developers"]
+language = "en"
+multilingual = false
+src = "src"
+
+[output.html]
+additional-js = ["./tabs.js"]
+additional-css = ["./mdbook-admonish.css"]
+git-repository-url = "https://github.com/rust-nostr/nostr"
+edit-url-template = "https://github.com/rust-nostr/nostr/edit/master/{path}"
+
+[preprocessor]
+
+[preprocessor.admonish]
+command = "mdbook-admonish"
+assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`

book/contrib/content-tabs-template.md

@@ -0,0 +1,37 @@
+<custom-tabs category="lang">
+
+<div slot="title">Rust</div>
+<section>
+
+TODO
+
+</section>
+
+<div slot="title">Python</div>
+<section>
+
+TODO
+
+</section>
+
+<div slot="title">JavaScript</div>
+<section>
+
+TODO
+
+</section>
+
+<div slot="title">Kotlin</div>
+<section>
+
+TODO
+
+</section>
+
+<div slot="title">Swift</div>
+<section>
+
+TODO
+
+</section>
+</custom-tabs>

book/justfile

@@ -0,0 +1,2 @@
+test:
+	cd snippets && just test