Skip to content

rmourey26/noogle

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Website GitHub top language GitHub Workflow Status built-with-dream2nix

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.

About

https://noogle.dev - nix function exploring. [maintainer=@hsjobeki]

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 48.1%
  • Nix 38.8%
  • Rust 9.7%
  • JavaScript 2.8%
  • CSS 0.6%