nix-community/noogle
1
1
Fork 0
mirror of https://github.com/nix-community/noogle.git synced 2024-11-22 14:45:15 +03:00
Code Issues Packages Projects Releases Wiki Activity
https://noogle.dev - nix function exploring.
128 Commits 26 Branches 1 Tag 4.6 MiB
Nix 53%
TypeScript 29.2%
Rust 15.5%
MDX 1.5%
CSS 0.5%
Other 0.3%
d00ae31da1
Go to file
Johannes Kirschbauer d00ae31da1 add vendor about test_assets
2024-01-07 17:20:35 +01:00
.github update github workflow 2023-11-29 21:40:20 +01:00
codemod fix layout, add more tests 2024-01-07 17:20:35 +01:00
indexer hook legacy data in ui build 2023-11-29 21:37:07 +01:00
pasta add vendor about pdef 2024-01-07 17:20:35 +01:00
pesto fix layout, add more tests 2024-01-07 17:20:35 +01:00
salt add links and hints for undocumented lambdas 2024-01-07 17:20:35 +01:00
scripts hook legacy data in ui build 2023-11-29 21:37:07 +01:00
tests update: main 2023-09-21 08:40:02 +02:00
website fix layout, add more tests 2024-01-07 17:20:35 +01:00
.envrc INIT: first prototype of frontend 2022-11-26 10:36:08 +01:00
.gitattributes add vendor about test_assets 2024-01-07 17:20:35 +01:00
.gitignore use flake modules 2023-11-23 12:31:33 +01:00
devShell.nix add alias tracking and bulk tests 2023-11-28 17:28:51 +01:00
flake.lock redesign with subpages 2024-01-07 17:20:35 +01:00
flake.nix build with new data, remove leacy data 2024-01-07 17:20:35 +01:00
LICENSE Create LICENSE 2023-01-25 16:23:32 +01:00
preCommit.nix hook legacy data in ui build 2023-11-29 21:37:07 +01:00
projects.toml Feature/monorepo (#24) 2023-02-25 13:14:40 +01:00
README.md add vendor about pdef 2024-01-07 17:20:35 +01:00
treefmt.toml hook legacy data in ui build 2023-11-29 21:37:07 +01:00

README.md

Noogle

Website GitHub top language GitHub Workflow Status

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.