`flakedoc`

Render a Nix flake's extracted documentation into a static site

Name

flakedoc-0.1.0

pname

flakedoc

Version

0.1.0

Main program

flakedoc

Homepage

https://github.com/calebstewart/stewos

License

Built for

aarch64-darwin
x86_64-linux

Platforms

aarch64-darwin
aarch64-linux
aarch64-netbsd
armv5tel-linux
armv6l-linux
armv6l-netbsd
armv7a-linux
armv7l-linux
armv7l-netbsd
i686-freebsd
i686-linux
i686-netbsd
i686-openbsd
i686-windows
loongarch64-linux
m68k-linux
mips-linux
mips64-linux
mips64el-linux
mipsel-linux
mipsel-netbsd
powerpc-linux
powerpc-netbsd
powerpc64-linux
powerpc64le-linux
riscv32-linux
riscv32-none
riscv64-linux
riscv64-netbsd
s390x-linux
wasm32-wasi
wasm32-wasip1
x86_64-darwin
x86_64-freebsd
x86_64-linux
x86_64-netbsd
x86_64-openbsd
x86_64-redox
x86_64-solaris
x86_64-windows

Outputs

out

Defined in

pkgs/flakedoc/default.nix

Details

The rendering half of the documentation generator; the extraction half is lib.docs, which evaluates a flake into the JSON this consumes. Everything it needs is compiled in -- templates, stylesheet, syntax grammars and search -- so it runs with no network and no writable store, and the site it emits is self-contained with every internal link relative. That last part is what lets the result be published under a path prefix on GitHub Pages.

Build it

nix build .#flakedoc