foodogsquared/nix-module-wrapper-manager-fds
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nix-module-wrapper-manager-fds.git synced 2025-01-30 16:57:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
nix-module-wrapper-manager-fds/docs
History
Gabriel Arazas c2625afbff
Some checks failed
Check test suite / Check outputs (push) Has been cancelled
Details
Deploy documentation site / Build website (push) Has been cancelled
Details
Deploy documentation site / Deploy website (push) Has been cancelled
Details
Update Nix dependencies / update-nix-deps (push) Has been cancelled
Details
chore: reformat codebase
2025-01-12 17:58:39 +08:00
..
manpages wrapper-manager-fds/docs: add notes in manpage 2024-08-31 11:34:40 +08:00
website docs/website: update Hugo modules 2024-11-21 13:40:06 +08:00
.gitignore wrapper-manager-fds/docs: reorganize to make way for other docs output 2024-07-21 20:22:02 +08:00
default.nix chore: reformat codebase 2025-01-12 17:58:39 +08:00
Gemfile wrapper-manager-fds/docs: init Ruby environment 2024-07-14 13:36:03 +08:00
Gemfile.lock wrapper-manager-fds/docs: init Ruby environment 2024-07-14 13:36:03 +08:00
gemset.nix chore: reformat codebase 2025-01-12 17:58:39 +08:00
hugo-build-module.nix docs: make base URL configurable through Nix 2024-11-11 18:48:54 +08:00
LICENSE wrapper-manager-fds/docs: init subproject 2024-07-14 11:14:22 +08:00
README.adoc wrapper-manager-fds/docs: reorganize to make way for other docs output 2024-07-21 20:22:02 +08:00

README.adoc

This is where the documentation is created, namely both the website and the manual page.

  • The website is powered by Hugo and it is pretty much what makes most of the files here. It requires Hugo and whatever Hugo module feature requires so it isn’t possible to build it offline. For now, we rely on the remote CI having network access for it (which is pretty much the standard for the most part so no worries there).

  • The manual page is powered by some under-documented tool in the Nix ecosystem (as is tradition) called nixos-render-docs. The adjacent tools in the Nix-module-options-doc-generation ecosystem are also what makes the (autogenerated) Nix module options pages found in the website.