Update to mdbook 0.5.x compatibility (#19)

* Initial plan

* Update mdbook dependency from 0.4.x to 0.5.x

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Update imports to use mdbook-preprocessor and mdbook-core 0.5.x APIs

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Fix CLI to properly handle supports subcommand

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Remove unnecessary lifetime parameters from get_config_string

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Fix CI workflows to extract mdbook version from mdbook-core dependency

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Fix CI workflows to check and reinstall mdbook if version mismatches

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Fix test book.toml preprocessor path to use correct relative path

Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>

* Fix mdbook compatibility by updating book.toml and modifying scroll-to-top button SVG

* refactor: remove raw type for mdbook, setup mdbook installation in workflows and update documentation for include app

* Fix paths for setup actions in workflows to ensure correct execution

* fix: update output setting for version retrieval in release workflow

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: MR-Addict <75357598+MR-Addict@users.noreply.github.com>
Co-authored-by: Cael <MR-Addict@qq.com>

Author: Copilot

.github/actions/setup-mdbook/action.yml

@@ -0,0 +1,22 @@
+name: "Install mdbook"
+description: "Install mdbook based on Cargo.toml version"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Install mdbook
+      run: |
+        REQUIRED_VERSION="$(grep '^mdbook-core' Cargo.toml | sed 's/.*"\([^"]*\)".*/\1/')"
+        if command -v mdbook >/dev/null 2>&1; then
+          INSTALLED_VERSION="$(mdbook --version | awk '{print $2}')"
+          if [ "$INSTALLED_VERSION" = "$REQUIRED_VERSION" ]; then
+            echo "mdbook $INSTALLED_VERSION is already installed."
+          else
+            echo "mdbook $INSTALLED_VERSION is installed but we need $REQUIRED_VERSION. Reinstalling..."
+            cargo install mdbook --version "$REQUIRED_VERSION" --force
+          fi
+        else
+          echo "mdbook not found. Installing version $REQUIRED_VERSION..."
+          cargo install mdbook --version "$REQUIRED_VERSION" --force
+        fi
+      shell: bash

.github/workflows/page.yaml

@@ -18,18 +18,13 @@ jobs:
         uses: ./.github/actions/setup-rust
 
       - name: Install mdbook
-        run: |
-          if ! command -v mdbook >/dev/null 2>&1; then
-            cargo install mdbook --version "$(grep '^mdbook' Cargo.toml | sed 's/.*"\([^"]*\)".*/\1/')" --force
-          else
-            echo "mdbook is already installed, skipping."
-          fi
+        uses: ./.github/actions/setup-mdbook
 
       - name: Run tests
         run: cargo test --all-features --verbose
 
       - name: Build book
-        run: mdbook build docs
+        run: head -n 5 README.md > docs/src/index.md && mdbook build docs
 
       - name: Deploy to github pages
         uses: crazy-max/ghaction-github-pages@v4

.github/workflows/release.yaml

@@ -14,12 +14,7 @@ jobs:
         uses: ./.github/actions/setup-rust
 
       - name: Install mdbook
-        run: |
-          if ! command -v mdbook >/dev/null 2>&1; then
-            cargo install mdbook --version "$(grep '^mdbook' Cargo.toml | sed 's/.*"\([^"]*\)".*/\1/')" --force
-          else
-            echo "mdbook is already installed, skipping."
-          fi
+        uses: ./.github/actions/setup-mdbook
 
       - name: Run tests
         run: cargo test --all-features --verbose
@@ -74,7 +69,7 @@ jobs:
 
       - name: Get the version
         id: get_version
-        run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+        run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
 
       - name: Install packages
         run: sudo apt update && sudo apt install -y upx-ucl zip