nix-community/noogle
1
1
Fork 0
mirror of https://github.com/nix-community/noogle.git synced 2024-09-11 09:15:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

style(readme): wrap text at 80 characters

Browse Source
This commit is contained in:
NAHO 2024-01-23 03:07:20 +01:00
parent 13c5d9eb33
commit 4fa797bc7d
No known key found for this signature in database
GPG Key ID: 1D2207B4D979BE3E
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -17,7 +17,8 @@
- 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.
- [x] Outputs pre-rendered static HTML that is indexable by other search engines.
- [x] Outputs pre-rendered static HTML that is indexable by other search
engines.
- [x] Wasm based performant search.
## Available data
@ -43,7 +44,8 @@ Normally indexed:
# Off the tree functions
Some function are not part of the evaluation value of `default.nix` in Nixpkgs. They must be imported individually.
Some function are not part of the evaluation value of `default.nix` in Nixpkgs.
They must be imported individually.
- `make-disk-image`
@ -53,8 +55,8 @@ All Indexing is done via the [pasta](./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`.
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!
@ -62,16 +64,17 @@ Indexed data can be added very easily in `./pasta/src/eval.nix`.
`nix build .#ui`
This page generates static HTML pages.
One page per API function.
This page generates static HTML pages. One page per API function.
It automatically includes meta tags for other search engines like Google or Bing.
It automatically includes meta tags for other search engines like Google or
Bing.
Searching within the page is done via [pagefind](https://pagefind.app/) which is only available in the production build.
Searching within the page is done via [pagefind](https://pagefind.app/) which is
only available in the production build.
### Develop
`nix develop`
This command creates the `node_modules` directory
with all needed dependencies based on `dream2nix`.
This command creates the `node_modules` directory with all needed dependencies
based on `dream2nix`.