From b4e526996cdae4b04f879ebe2d31dc074fe7a17e Mon Sep 17 00:00:00 2001 From: Mamadou Babaei Date: Wed, 4 Feb 2026 17:03:44 +0100 Subject: [PATCH] bump mdBook to v0.5.2 --- Handbook/GNUmakefile | 7 +++---- Handbook/bin/sg-preprocessor.sh | 10 +++++----- Handbook/book.toml | 6 +----- Handbook/src/appendix/changelog.md | 9 +++++++++ 4 files changed, 18 insertions(+), 14 deletions(-) diff --git a/Handbook/GNUmakefile b/Handbook/GNUmakefile index bc9b345b..c5ac8aee 100644 --- a/Handbook/GNUmakefile +++ b/Handbook/GNUmakefile @@ -365,17 +365,16 @@ clean: .PHONY: install-build-deps install-build-deps: @echo "Installing build dependencies if they have not already been installed..." - @cargo install mdbook --version "0.4.49" --locked + @cargo install mdbook --version "0.5.2" --locked @cargo install xq --vers "^0.4" --locked - @cargo install mdbook-alerts --vers "^0.7" --locked - @cargo install mdbook-pdf --vers "0.1.11" --locked + @cargo install mdbook-pdf --vers "0.1.13" --locked ifeq ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX)) @echo "Installing mdbook-pdf-outline..." @python -m venv $(VIRTUAL_ENV) \ && . $(SG_LINUX_PYTHON_VENV_BIN_DIR)/activate \ && pip install mdbook-pdf-outline 2>/dev/null endif # ($(SG_BUILD_PLATFORM),$(SG_BUILD_PLATFORM_LINUX)) - @cargo install --git https://github.com/Michael-F-Bryan/mdbook-epub --rev cac03b7f4b151f106f7f05b13da4c33fc098dd2c --locked + @cargo install --git https://github.com/Michael-F-Bryan/mdbook-epub --rev 21a1c8134134201a2d555313447c96e56e2a8996 --locked ################################################################################ # Make Targets - mdBook diff --git a/Handbook/bin/sg-preprocessor.sh b/Handbook/bin/sg-preprocessor.sh index bac7793d..84343d55 100644 --- a/Handbook/bin/sg-preprocessor.sh +++ b/Handbook/bin/sg-preprocessor.sh @@ -33,8 +33,8 @@ fi readonly JSON_INPUT=$(cat) -readonly CONTEXT=$(echo "${JSON_INPUT}" | xq '.[0]') -readonly BOOK=$(echo "${JSON_INPUT}" | xq '.[1]') +readonly CONTEXT=$(printf '%s' "${JSON_INPUT}" | xq '.[0]') +readonly BOOK=$(printf '%s' "${JSON_INPUT}" | xq '.[1]') escape_string() { printf '%s' "$1" | sed -e 's/\\/\\\\/g' -e 's/"/\\"/g' @@ -63,8 +63,8 @@ SG_PLUGIN_VERSION_PATCH_ESCAPED=$(escape_string "${SG_PLUGIN_VERSION_PATCH}") SG_BUILD_HOST_ESCAPED=$(escape_string "${SG_BUILD_HOST}") SG_BUILD_TIME_ESCAPED=$(escape_string "${SG_BUILD_TIME}") -PARSED_BOOK=$(echo "${BOOK}" | xq " - .sections[] |= ( +PARSED_BOOK=$(printf '%s' "${BOOK}" | xq " + .items[] |= ( if has(\"Chapter\") then .Chapter.content |= walk(if type == \"string\" then @@ -103,4 +103,4 @@ PARSED_BOOK=$(echo "${BOOK}" | xq " #echo "BOOK: ${BOOK}" >&2 #echo "PARSED_BOOK: ${PARSED_BOOK}" >&2 -echo "${PARSED_BOOK}" | xq '.' \ No newline at end of file +printf '%s' "${PARSED_BOOK}" \ No newline at end of file diff --git a/Handbook/book.toml b/Handbook/book.toml index 2722b276..f4dee596 100644 --- a/Handbook/book.toml +++ b/Handbook/book.toml @@ -28,7 +28,6 @@ authors = ["Mamadou Babaei"] description = "Welcome to the SenseGlove Unreal Engine documentation!" language = "en" -multilingual = false src = "src" text-direction = "ltr" title = "The SenseGlove Unreal Engine Handbook" @@ -43,8 +42,6 @@ use-default-preprocessors = true [preprocessor.links] -[preprocessor.alerts] - [preprocessor.senseglove] after = [ "index", "links" ] command = "sh ./bin/sg-preprocessor.sh" @@ -59,10 +56,9 @@ footnote-backrefs = true additional-css = ["styles/custom.css"] additional-js = [] cname = "unreal.docs.senseglove.com" -copy-fonts = true default-theme = "navy" git-repository-url = "https://dev.azure.com/SenseGlove/_git/SenseGlove-Unreal" -git-repository-icon = "fa-git" +git-repository-icon = "fab-git" input-404 = "404.md" mathjax-support = false no-section-label = false diff --git a/Handbook/src/appendix/changelog.md b/Handbook/src/appendix/changelog.md index e377fe22..34270db1 100644 --- a/Handbook/src/appendix/changelog.md +++ b/Handbook/src/appendix/changelog.md @@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [Unreleased] + +### Documentation + +- Bumped [mdBook](https://rust-lang.github.io/mdBook/) to `v0.5.2` +- Bumped the [Michael-F-Bryan/mdbook-epub](https://github.com/Michael-F-Bryan/mdbook-epub) crate to [`21a1c8134134201a2d555313447c96e56e2a8996`](https://github.com/Michael-F-Bryan/mdbook-epub/commit/21a1c8134134201a2d555313447c96e56e2a8996), which addresses issue [#133](https://github.com/Michael-F-Bryan/mdbook-epub/issues/133). This allowed upgrading mdBook from `0.4.49` to `v0.5.2` without breaking images inside the generated ePub version of the handbook. +- Bumped [HollowMan6/mdbook-pdf](https://github.com/HollowMan6/mdbook-pdf) to `v0.1.13`. +- Removed [lambdalisue/rs-mdbook-alerts](https://github.com/lambdalisue/rs-mdbook-alerts) as it's incompatible with mdBook `v0.5.x`. The good news is that mdBook itself is now able to support this feature natively. + ## [2.7.2] - 2026-02-17 This patch release resolves build issues affecting Unreal Engine `5.7` on Linux `Arm64` architecture.