mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs/fix-links: init

Browse source 
The README/CONTRIBUTING files are authored with GitHub in mind, but we
want to re-use them for the docs website.

Replace the existing simple substitution with a pandoc AST-based filter.
This commit is contained in:
Matt Sturgeon 2025-02-13 15:43:06 +00:00
parent ff63fc92ed
commit 7f29e4b2ae
No known key found for this signature in database
GPG key ID: 4F91844CED1A8299
3 changed files with 84 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/mdbook/default.nix
View file

@ -317,7 +317,6 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
fileset = lib.fileset.unions [
../user-guide
../platforms
../../CONTRIBUTING.md
(lib.fileset.fileFilter (
{ type, hasExt, ... }:
type == "regular"
@ -330,6 +329,8 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
];
};
contributing = finalAttrs.passthru.fix-links ../../CONTRIBUTING.md;
buildPhase = ''
dest=$out/share/doc
mkdir -p $dest
@ -339,6 +340,9 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
mv ./docs/* ./ && rmdir ./docs
mv ./mdbook/* ./ && rmdir ./mdbook
# Copy the contributing file
cp $contributing ./CONTRIBUTING.md
# Copy the generated MD docs into the build directory
bash -e ${finalAttrs.passthru.copy-docs}
@ -382,21 +386,22 @@ pkgs.stdenv.mkDerivation (finalAttrs: {
;
passthru = {
fix-links = callPackage ../fix-links {
# FIXME: determine values from availableVersions & baseHref
docsUrl = "https://nix-community.github.io/nixvim/";
githubUrl = "https://github.com/nix-community/nixvim/blob/main/";
};
copy-docs = pkgs.writeShellScript "copy-docs" docs.commands;
readme =
runCommand "readme"
{
start = "<!-- START DOCS -->";
end = "<!-- STOP DOCS -->";
baseurl = "https://nix-community.github.io/nixvim/";
src = ../../README.md;
src = finalAttrs.passthru.fix-links ../../README.md;
}
''
# extract relevant section of the README
sed -n "/$start/,/$end/p" $src > $out
# replace absolute links
substituteInPlace $out --replace-quiet "$baseurl" "./"
# TODO: replace .html with .md
'';
search = search.override {
baseHref = finalAttrs.baseHref + "search/";