A static-site generator for creating searchable documentation of NixOS configuration options without Elasticsearch.
NüschtOS Search is a static-site generator that creates searchable web interfaces for NixOS configuration options. It allows developers to document and explore options from NixOS modules or flakes without needing a dynamic backend. The tool solves the problem of creating lightweight, deployable search interfaces similar to search.nixos.org but with zero runtime dependencies.
NixOS developers and maintainers who need to provide searchable documentation for their module options, particularly those managing multiple flakes or projects.
Developers choose NüschtOS Search because it eliminates the need for Elasticsearch or other complex search backends, generating entirely static sites that can be hosted anywhere. Its flexibility in handling multiple scopes and input formats makes it ideal for documenting diverse NixOS projects.
Simple and fast static-page NixOS option search
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates complete HTML and JSON files that can be deployed on static hosts like GitHub Pages or Cloudflare Pages, eliminating backend infrastructure as motivated by the project's goal to avoid Elasticsearch.
Supports mkMultiSearch to combine multiple modules or flakes into a single search interface, ideal for community collections like the deployments listed for NixVim and C3D2.
Accepts either NixOS modules directly or pre-generated options.json files, providing versatility in sourcing option documentation as outlined in the usage options.
When urlPrefix is configured, it creates clickable links to option declarations in source code, enhancing documentation usability and traceability.
Tightly coupled to the NixOS module system; it cannot be used for documenting configurations in other languages or frameworks without significant adaptation.
Any updates to modules require a full rebuild and redeploy of the search site, which can be cumbersome for actively developed projects, unlike dynamic backends.
Issues like missing declarations or malformed defaults often require manual fixes in source modules, as detailed in the FAQ, adding maintenance burden for users.