How can I build and preview den's documentation locally?

[crasm]

How can I build and preview den's documentation locally?

[crasm]

Just writing up what was necessary to run the docs. I would like to have a nix shell for this with maybe a hook for installing the pnpm packages, but not entirely clear how to do that in the existing flake.

Ironically, the docs for how to write docs are not complete.

[crasm]

First, clone your fork of the repository.

$ git clone 'https://github.com/<your-username>/den'
$ cd den

Next, enter a nix shell.

## Classic tooling
$ nix-shell -p just nodejs pnpm
## or flakes tooling!
$ nix shell 'nixpkgs#just nixpkgs#nodejs nixpkgs#pnpm'

Then, change to the docs directory and install the necessary dependencies to docs/node_modules.

$ cd docs
$ pnpm install

Finally, start the docs webserver.

$ just docs

Now, you can edit the files in docs/src/content/docs and see your changes reflected immediately.

[vic]

I use the following .envrc

use_nix_installables() {
  direnv_load nix shell "${@}" -c $direnv dump
}

use nix_installables \
nixpkgs#nix-unit \
nixpkgs#just \
nixpkgs#npins \
nixpkgs#pnpm \
nixpkgs#nodejs \
nixpkgs#hyperfine

Maybe we could either provide it as .envrc-example or, even better, expose a devShell just like we do from nix/flake-packages.nix without introducing dependencies in Den itself. Feel free to send a PR for any of those.