Noogle

Noogle is a simple Nix API search engine. It lets you search Nix functions.

Current Features

• Beginners-friendly search for Nix and Nix-related functions.
  • Render documentation comments optimized for readability.
  • Search optimized for English language and Nix function-names.
• Filter by type signatures.
  • Function types are parsed and interpreted.
• Noogle also knows stuff that is not (yet) officially documented.
  • Types of builtins (including builtins.derivation).
  • Can be extended via markdown contributions to Noogle.
  • Always shows the latest docs based on the main branch of Nixpkgs.
• Outputs pre-rendered static HTML that is indexable by other search engines.
• Wasm based performant search.

Nice features

• Detect aliases of (most) lib and builtins functions
• Override builtins documentation by documenting their alias in nixpkgs.lib. So you don't need to change and rebuild cpp nix anymore.
• nix and nixpkgs are updated daily. All documentation changes will be picked up just the next day.

---

All Indexing is done via the pasta module. PRs welcome!

Additional data - such as types of builtins - are available in salt

Contribute

Contributions are very welcome just file a PR or issue. Indexed data can be added very easily in ./pasta/src/eval.nix.

Note: Indexed data must evaluate!

Build this page

nix build .#ui

This page generates static HTML pages. One page per API function.

It automatically includes meta tags for other search engines like Google or Bing.

Searching within the page is done via pagefind which is only available in the production build.

Develop

nix develop

This command creates the node_modules directory with all needed dependencies based on dream2nix.