nix-community/noogle
1
1
Fork 0
mirror of https://github.com/nix-community/noogle.git synced 2024-11-29 23:02:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
https://noogle.dev - nix function exploring.
291 Commits 26 Branches 1 Tag 4.7 MiB
Nix 53%
TypeScript 29.2%
Rust 15.5%
MDX 1.5%
CSS 0.5%
Other 0.3%
90aa68fcc6
Go to file
github-actions[bot] 90aa68fcc6 flake.lock: Update 
Flake lock file updates:

• Updated input 'nixpkgs-master':
    'github:NixOS/nixpkgs/4da0f532ba46f8af133f7554ebc4c18e6939af8a' (2024-05-04)
  → 'github:NixOS/nixpkgs/0be9c41d543eda69daeb385c2432a60a7127528c' (2024-05-05)
2024-05-05 00:45:18 +00:00
.github add automerge label to automatic updates 2024-01-31 22:47:42 +07:00
codemod clean unsed code 2024-03-16 22:23:34 +01:00
pasta website: add update date for docs 2024-03-25 13:16:18 +01:00
pesto simplify .envrc 2024-04-29 21:18:47 +00:00
salt add configurable nix-manual references 2024-01-07 17:20:35 +01:00
tests update: main 2023-09-21 08:40:02 +02:00
website Website: improve search result preview metadata 2024-04-11 09:43:29 +00: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
.mergify.yml Update .mergify.yml 2024-01-31 22:57:13 +07:00
devShell.nix add alias tracking and bulk tests 2023-11-28 17:28:51 +01:00
flake.lock flake.lock: Update 2024-05-05 00:45:18 +00:00
flake.nix remove deprecated submodules 2024-04-29 21:18:47 +00: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 update release notes 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 simple 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
    • Search optimized for English language and nix function-names.
  • Filter by type signatures.
    • Function types are parsed and interpreted.
  • 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.
  • Outputs Pre-rendered static html that is indexable by other search engines.
  • 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 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 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.