noogle/README.md

Noogle

Noogle is a 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
• Filter by type signatures.
  • Function types are parsed and interpreted.
• Noogle also knows stuff that is not 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 instant search.

Available data

There are the following subsets of nix functions available.

Recursively Indexed:

• lib
• pkgs.rustPackages

Normally Indexed:

• builtins
• pkgs.stdenv
• pkgs.dockerTools
• pkgs.writers
• pkgs.pythonPackages
• pkgs.haskell.lib
• pkgs.dockerTools

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 .#

Develop

nix develop

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