mirror of
https://github.com/hsjobeki/noogle.git
synced 2024-08-16 16:20:45 +03:00
1.7 KiB
1.7 KiB
Noogle
Connect with us on matrix: #noogle:matrix.org
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
- We are working on a standard for in-code-documentation
- fuzzy-search.
- show why/what terms matched.
- Share results with a direct URL.
- 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.
- Search by type signatures.
- Function types are parsed and interpreted.
- We are working on a standard way to write type-documentation: typednix.dev
Available data
There are the following subsets of nix functions available:
- nix/builtins
- nixpkgs/lib
- nixpkgs/build-support/trivial-builders
Contribute
Contributions are very welcome to file a PR or issue.
Build this page
nix build .#
Develop
nix develop
This command creates the node_modules folder with all needed dependencies based on dream2nix.