fix: mdbook deploy by removing deprecated fields and fixing config

- Remove deprecated 'multilingual' field from book.toml
- Remove deprecated 'copy-fonts' field from book.toml
- Fix git-repository-icon: fa-github -> fab-github
- Fix workflow to use ./book (not ./book/html)
- Disable mdbook-linkcheck (incompatible with mdbook 0.5.x)
- Add ensure_mermaid_assets() to mdbook.sh to generate JS files before build

Author: ammar-agent

.github/workflows/docs.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: ./book/html
+          path: ./book
 
   deploy:
     environment:

book.toml

@@ -1,7 +1,6 @@
 [book]
 authors = ["Ammar Bandukwala"]
 language = "en"
-multilingual = false
 src = "docs"
 title = "httpjail"
 description = "HTTP(S) Request Jailing: Control what your processes can request"
@@ -20,12 +19,11 @@ command = "mdbook-mermaid"
 default-theme = "rust"
 preferred-dark-theme = "navy"
 git-repository-url = "https://github.com/coder/httpjail"
-git-repository-icon = "fa-github"
+git-repository-icon = "fab-github"
 edit-url-template = "https://github.com/coder/httpjail/edit/main/{path}"
 site-url = "https://coder.github.io/httpjail/"
 cname = ""
 mathjax-support = false
-copy-fonts = true
 additional-css = ["docs/custom.css"]
 additional-js = ["mermaid.min.js", "mermaid-init.js"]
 no-section-label = false
@@ -49,12 +47,9 @@ heading-split-level = 3
 
 [output.html.redirect]
 
-[output.linkcheck]
-# Optional: Only check internal links (faster builds)
-follow-web-links = false
-# Optional: Allow links outside book root
-traverse-parent-directories = false
-# Optional: Exclude patterns (regex)
-exclude = [ "^https://crates\\.io", "^https://docs\\.rs" ]
-# Optional: HTTP request configuration
-warning-policy = "warn"
+# Disabled: mdbook-linkcheck 0.7.7 is incompatible with mdbook 0.5.x
+# [output.linkcheck]
+# follow-web-links = false
+# traverse-parent-directories = false
+# exclude = [ "^https://crates\\.io", "^https://docs\\.rs" ]
+# warning-policy = "warn"

scripts/mdbook.sh

@@ -65,35 +65,39 @@ ensure_mdbook_mermaid() {
         exit 1
     fi
 
-    # Initialize mermaid support in the book
-    cd "${PROJECT_ROOT}"
-    mdbook-mermaid install .
 }
 
-# Install mdbook-linkcheck if not present
-ensure_mdbook_linkcheck() {
-    if command_exists mdbook-linkcheck; then
-        log_info "mdbook-linkcheck is already installed ($(mdbook-linkcheck --version 2>&1 | head -1 || echo 'unknown version'))"
-        return 0
-    fi
-
-    log_warn "mdbook-linkcheck not found, installing..."
-
-    if command_exists cargo; then
-        cargo install mdbook-linkcheck --locked
-    else
-        log_error "cargo not found. Please install Rust toolchain first: https://rustup.rs/"
-        exit 1
+# Ensure mermaid assets (JS files) are present
+ensure_mermaid_assets() {
+    cd "${PROJECT_ROOT}"
+    if [ ! -f "mermaid.min.js" ] || [ ! -f "mermaid-init.js" ]; then
+        log_info "Installing mermaid assets..."
+        mdbook-mermaid install .
     fi
 }
 
+# Disabled: mdbook-linkcheck 0.7.7 is incompatible with mdbook 0.5.x
+# ensure_mdbook_linkcheck() {
+#     if command_exists mdbook-linkcheck; then
+#         log_info "mdbook-linkcheck is already installed"
+#         return 0
+#     fi
+#     log_warn "mdbook-linkcheck not found, installing..."
+#     if command_exists cargo; then
+#         cargo install mdbook-linkcheck --locked
+#     else
+#         log_error "cargo not found"
+#         exit 1
+#     fi
+# }
+
 # Main installation check
 main() {
     log_info "Checking mdbook prerequisites..."
 
     ensure_mdbook
     ensure_mdbook_mermaid
-    ensure_mdbook_linkcheck
+    ensure_mermaid_assets
 
     log_info "All prerequisites satisfied"