mirror of
https://github.com/nix-community/noogle.git
synced 2024-07-14 12:40:20 +03:00
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
# [Noogle](https://noogle.dev)
|
|
|
|
|
|
|
|
|
|
|
|
### Noogle is a simple Nix API search engine. It lets you search nix functions.
|
|
|
|
## Current Features
|
|
|
|
- [x] Beginners-friendly search for nix and nix-related functions
|
|
- Render documentation comments optimized for readability
|
|
- Search optimized for English language and nix function-names.
|
|
- [x] Filter by **type** signatures.
|
|
- Function types are parsed and interpreted.
|
|
- [x] 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.
|
|
- [x] Outputs Pre-rendered static html that is indexable by other search engines.
|
|
- [x] Wasm based performant search.
|
|
|
|
## Available data
|
|
|
|
There are the following subsets of `nix` and `nixpkgs` functions available.
|
|
|
|
Recursively indexed:
|
|
|
|
- lib
|
|
- pkgs.rustPackages
|
|
|
|
> Recursively means all deeply nested sub-attributes.
|
|
|
|
Normally indexed:
|
|
|
|
- builtins
|
|
- pkgs.stdenv
|
|
- pkgs.dockerTools
|
|
- pkgs.writers
|
|
- pkgs.pythonPackages
|
|
- pkgs.haskell.lib
|
|
- pkgs.haskell.lib
|
|
|
|
# Off the tree functions
|
|
|
|
Some function are not part of the evaluation value of default.nix in nixpkgs. They must be imported individually.
|
|
|
|
- make-disk-image
|
|
|
|
---
|
|
|
|
All Indexing is done via the [pasta](./pasta/) module. PRs welcome!
|
|
|
|
## 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](https://pagefind.app/) which is only available in the production build.
|
|
|
|
### Develop
|
|
|
|
`nix develop`
|
|
|
|
This command creates the node_modules folder
|
|
with all needed dependencies based on dream2nix.
|