Set up the mdbook-replace preprocessor

book.toml

@@ -10,3 +10,24 @@ title = "Sonata Software"
 [output.html]
 git-repository-url = "https://github.com/lowRISC/sonata-software"
 edit-url-template = "https://github.com/lowRISC/sonata-software/edit/main/{path}"
+
+[preprocessor.replace]
+after = ["links"]
+
+# Replace all links to a README.md to an index.md
+link_replacements = [
+    {regex = '^(?P<path>[^:#\?]*)README\.md(?P<suffix>[?#].*)?', replacement = '${path}index.md${suffix}'},
+]
+
+[[preprocessor.replace.local_link_replacements]]
+# Replace all paths pointing to something in the cheriot-rtos
+# to a link pointing to them in github.
+regex = '^cheriot-rtos/*(?P<path>.*)?'
+replacement = 'https://github.com/CHERIoT-Platform/cheriot-rtos/tree/main/${path}'
+
+[[preprocessor.replace.local_link_replacements]]
+# Replace all paths pointing to something in this repository,
+# that is not a markdown file or image,
+# to a link pointing to them in github.
+regex = '[^:#\?]*[^(\.(md|svg|png))]([?#].*)?'
+replacement = 'https://github.com/lowRISC/sonata-software/tree/main/${0}'

flake.nix

@@ -7,6 +7,10 @@
     lowrisc-nix.follows = "sonata-system/lowrisc-nix";
     nixpkgs.follows = "lowrisc-nix/nixpkgs";
     flake-utils.follows = "lowrisc-nix/flake-utils";
+    mdutils = {
+      url = "git+https://codeberg.org/HU90m/mdutils.git";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
   };
 
   nixConfig = {
@@ -20,12 +24,14 @@
     flake-utils,
     lowrisc-nix,
     sonata-system,
+    mdutils,
   }: let
     system_outputs = system: let
       version = "0.0.1";
 
       pkgs = import nixpkgs {inherit system;};
       lrPkgs = lowrisc-nix.outputs.packages.${system};
+      mdutilsPkgs = mdutils.outputs.packages.${system};
       lrDoc = lowrisc-nix.lib.doc {inherit pkgs;};
       sonataSystemPkgs = sonata-system.outputs.packages.${system};
       cheriotPkgs = lowrisc-nix.outputs.devShells.${system}.cheriot.nativeBuildInputs;
@@ -48,6 +54,7 @@
           root = ./.;
           fileset = lrDoc.standardMdbookFileset ./.;
         };
+        buildInputs = [mdutilsPkgs.default];
       };
 
       sonata-tests = pkgs.stdenvNoCC.mkDerivation ({
@@ -156,7 +163,7 @@
       devShells = rec {
         default = pkgs.mkShell {
           name = "sonata-sw";
-          packages = cheriotPkgs ++ [lrPkgs.uf2conv pkgs.python3Packages.pyserial];
+          packages = cheriotPkgs ++ [lrPkgs.uf2conv pkgs.python3Packages.pyserial mdutilsPkgs.default];
         };
         env-with-sim = pkgs.mkShell {
           name = "sonata-sw-with-sim";