Nix'ify docs website, and check for broken links in CI #398
Conversation
|
As expected CI fails due to broken links:
|
srid
changed the title
srid
changed the title
|
actually could you also fix the hyperlink here please - I accidentally made it |
Yup.
Not right now, but eventually1 I'd like to integrate something like https://stork-search.net/ into Emanote. Footnotes
|
|
One small thing, what's up with the github issue hyperlinks getting skewed?
Check the troubleshooting section for example. It seems to generate two links from it. |
|
That's due to inline tag parser getting in the way: srid/emanote#167 A workaround would be to escape the Relevant issue: [\#275](https://github.com/Plutonomicon/plutarch/issues/275) |
... srid/emanote#167 is resolved.
| rec { | ||
| type = "app"; | ||
| # '' is required for escaping ${} in nix | ||
| script = (nixpkgsFor system).writers.writeBash "emanoteLiveReload.sh" '' |
There was a problem hiding this comment.
How is this different from writeShellScriptBin?
There was a problem hiding this comment.
It's a copy-paste from plutonomicon, but now that you mention it I realize we should instead be using checkedShellScript from the flake.
Adds
nix run .#docsto run a live web view of docs locally. As well asnix run .#websiteto build the static website. This is the same as what we do in https://github.com/Plutonomicon/plutonomicon - but using a newer version of Emanote containing support for the full range of relative links.The latter command also checks for broken links (the CI for this PR succeeds because those broken links have been fixed here).
Eventually, we can include Haddock generated HTML in the generated site of
nix run .#website, before deploying it statically to GH pages using #393.