noogle

ヌーグル

Noogle は、シンプルな Nix API 検索エンジンです。 Nix 関数を検索できます。

現在の機能

• Nix および Nix 関連関数の初心者向けの検索。
  • 読みやすさを考慮してドキュメントのコメントを最適化して表示します。
  • 英語と Nix 関数名に最適化された検索。
• タイプシグネチャでフィルターします。
  • 関数の型は解析されて解釈されます。
• Noogle は、（まだ）公式に文書化されていないことも知っています。
  • builtinsのタイプ ( builtins.derivationを含む)。
  • Noogle へのマークダウン貢献を通じて拡張できます。
  • Nixpkgs のメイン ブランチに基づいた最新のドキュメントを常に表示します。
• 他の検索エンジンでインデックス付けできる、事前にレンダリングされた静的 HTML を出力します。
• Wasm ベースのパフォーマンス検索。

利用可能なデータ

使用可能な Nix および Nixpkgs 関数の次のサブセットがあります。

再帰的にインデックス付けされる:

• lib
• pkgs.rustPackages

再帰的とは、深くネストされたすべてのサブ属性を意味します。

通常はインデックスが付けられます:

• builtins
• pkgs.stdenv
• pkgs.dockerTools
• pkgs.writers
• pkgs.pythonPackages
• pkgs.haskell.lib
• pkgs.haskell.lib

ツリー外の関数

Nixpkgsのdefault.nixの評価値に含まれない関数もあります。これらは個別にインポートする必要があります。

• make-disk-image

---

すべてのインデックス作成は、pasta モジュールを介して行われます。 PRの方も大歓迎！

貢献する

PR または問題を提出するだけの貢献は大歓迎です。インデックス付きデータは./pasta/src/eval.nixに非常に簡単に追加できます。

注: インデックス付きデータは評価する必要があります。

このページを構築する

nix build .#ui

このページは静的 HTML ページを生成します。 API 関数ごとに 1 ページ。

Google や Bing などの他の検索エンジンのメタ タグが自動的に含まれます。

ページ内の検索は、実稼働ビルドでのみ使用できる pagefind を介して行われます。

開発する

nix develop

このコマンドはdream2nixに基づいて、必要なすべての依存関係を含むnode_modulesディレクトリを作成します。