Add a link to the documentation from the README

barrucadu · Oct 16, 2023 · 0536420 · 0536420
1 parent 68793f8
commit 0536420
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/README.markdown b/README.markdown
@@ -4,6 +4,8 @@ nixfiles
 My [NixOS][] configuration and assorted other crap, powered by [flakes][].
 Clone to `/etc/nixos`.
 
+See [the documentation](https://nixfiles.docs.barrucadu.co.uk).
+
 CI checks ensure that code is formatted and passes linting.  Run those locally
 with:
 

diff --git a/flake.nix b/flake.nix
@@ -115,7 +115,7 @@
               };
             in
             mkApp "documentation" ''
-              PATH=${with pkgs; lib.makeBinPath [ coreutils mdbook mdbook-admonish python3 ]}
+              PATH=${with pkgs; lib.makeBinPath [ coreutils gnused mdbook mdbook-admonish python3 ]}
               export NIXOS_OPTIONS_JSON="${optionsDoc.optionsJSON}/share/doc/nixos/options.json"
 
               ${pkgs.lib.fileContents ./scripts/documentation.sh}

diff --git a/scripts/documentation.sh b/scripts/documentation.sh
@@ -4,7 +4,7 @@ pushd docs
 mdbook-admonish install
 popd
 
-cp README.markdown docs/src/README.md
+sed 's#See \[the documentation\].*##' < README.markdown > docs/src/README.md
 
 python3 - <<'EOF' > docs/src/hosts.md
 import os