mirror of
https://github.com/nix-community/noogle.git
synced 2024-09-11 09:15:53 +03:00
README: add readme
This commit is contained in:
parent
c51722be2d
commit
151b0b35b4
36
README.md
36
README.md
@ -1,27 +1,27 @@
|
|||||||
# Static page with nextjs example
|
# Noogle
|
||||||
|
|
||||||
- Generates a static page
|
Noogle is a Nix API search engine. It allows you to search functions based on their types and other attributes in `nix` projects. In `nixpkgs` especially the `builtins` and `lib` attributes.
|
||||||
- Includes custom Image loader for static page generation
|
|
||||||
|
|
||||||
## Build
|
- Beginners-friendly search for nix and nix-related functions
|
||||||
|
- Expert search with directly typing type signatures
|
||||||
|
- Search functions based on:
|
||||||
|
- type
|
||||||
|
- signature
|
||||||
|
- name
|
||||||
|
- tree-search from one type to another
|
||||||
|
|
||||||
|
## How it works
|
||||||
|
|
||||||
> ### ! The build step is completly independent of develop step and can be run right after checkout
|
The idea is to use a fork of `nixdoc`to generate json data from all functions. That have the `Type` field which is currently supported from nixdoc.
|
||||||
|
|
||||||
|
## Contrbute
|
||||||
|
|
||||||
|
### Build this page
|
||||||
|
|
||||||
`nix build .#`
|
`nix build .#`
|
||||||
|
|
||||||
This should create to following result:
|
### Develop
|
||||||
|
|
||||||
- static/
|
|
||||||
- __index.html__
|
|
||||||
- favicon.ico
|
|
||||||
- 404.html
|
|
||||||
- vercel-svg
|
|
||||||
- _next/
|
|
||||||
- static/...
|
|
||||||
- ...
|
|
||||||
|
|
||||||
## Develop
|
|
||||||
|
|
||||||
`nix develop`
|
`nix develop`
|
||||||
|
|
||||||
This command creates the node_modules folder with all needed dependencies
|
This command creates the node_modules folder with all needed dependencies based on dream2nix.
|
||||||
|
Loading…
Reference in New Issue
Block a user