Git Product home page Git Product logo

noogle's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.