hsjobeki/noogle
1
1
Fork 0
mirror of https://github.com/hsjobeki/noogle.git synced 2024-12-28 16:32:17 +03:00
Code Issues Projects Releases Wiki Activity

update release notes

Browse Source
This commit is contained in:
Johannes Kirschbauer 2024-01-07 16:54:25 +01:00 committed by Johannes Kirschbauer
parent 54530f99e6
commit baaade7c9f
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -4,20 +4,21 @@
![GitHub top language](https://img.shields.io/github/languages/top/hsjobeki/noogle)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/hsjobeki/noogle/main.yml)
### Noogle is a Nix API search engine. It lets you search nix functions.
### Noogle is a simple Nix API search engine. It lets you search nix functions.
## Current Features
- [x] Beginners-friendly search for nix and nix-related functions
- Render documentation comments optimized for readability
- Search optimized for English language and nix function-names.
- [x] Filter by **type** signatures.
- Function types are parsed and interpreted.
- [x] Noogle also knows stuff that is not officially documented.
- [x] 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.
- [x] Outputs Pre-rendered static html that is indexable by other search engines.
- [x] Wasm based performant instant search.
- [x] Wasm based performant search.
## Available data

7
website/src/app/md/release/2024-1/page.mdx
View File

@ -56,12 +56,11 @@ The search website has undergone a significant overhaul to highlight the massive
Source links point to my autogenerated fork of nixpkgs.
Because: ...
This will be solved within the next weeks.
nixpkgs doesnt officially support markdown in doc-comments yet. Although the RFC145 is accepted things need to be done.
current ly nixpkgs doesnt fully support markdown in doc-comments yet. Although the RFC145 is accepted things need to be done.
The current nixpkgs manual rendering involves ~5k lines of a custom parser written in python.
It fails to generate any output if given real markdown from our doc-comments. Please feel free to contribute there.
Please feel free to contribute there.
## Happy searching!