hsjobeki/noogle
1
1
Fork 0
mirror of https://github.com/hsjobeki/noogle.git synced 2024-12-25 15:04:30 +03:00
Code Issues Projects Releases Wiki Activity
https://noogle.dev - like hoogle but for nix
92 Commits 27 Branches 1 Tag 4.8 MiB
Nix 52.9%
TypeScript 29.1%
Rust 15.7%
MDX 1.5%
CSS 0.5%
Other 0.3%
8e07a30808
Go to file
hsjobeki 8e07a30808 autocomplete: init
2023-09-21 10:59:17 +02:00
.github renovate: init 2023-09-21 08:54:38 +02:00
indexer moved: trivial builders relinked to nixpkgs 2023-06-25 17:47:29 +02:00
scripts Feature/monorepo (#24) 2023-02-25 13:14:40 +01:00
tests update: main 2023-09-21 08:40:02 +02:00
website autocomplete: init 2023-09-21 10:59:17 +02:00
.envrc INIT: first prototype of frontend 2022-11-26 10:36:08 +01:00
.gitignore Feature/monorepo (#24) 2023-02-25 13:14:40 +01:00
flake.lock update: main 2023-09-21 08:40:02 +02:00
flake.nix add: build_support directory there are 'plugins.nix' and other files that have documentation 2023-06-25 17:47:29 +02:00
LICENSE Create LICENSE 2023-01-25 16:23:32 +01:00
projects.toml Feature/monorepo (#24) 2023-02-25 13:14:40 +01:00
README.md Update README.md 2023-06-18 19:11:55 +02:00

README.md

Noogle

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.