noogle/README.md

# [Noogle](https://noogle.dev)

![Website](https://img.shields.io/website?down_message=noogle.dev&up_message=noogle.dev&url=https%3A%2F%2Fnoogle.dev)
![GitHub top language](https://img.shields.io/github/languages/top/hsjobeki/noogle)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hsjobeki/noogle/main.yml)

### Noogle is a 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
- [x] Filter by **type** signatures.
  - Function types are parsed and interpreted.
- [x] 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.
- [x] Outputs Pre-rendered static html that is indexable by other search engines.
- [x] 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.