i3months/eziwiki

これは何？

主な機能

• 01content/内のファイルは自動で公開され、フォルダはサイドバーのセクションになります。
• 02ブラウザ内で全文検索を実行し、見出しとページ本文をインデックス化します。
• 03Wikiリンクはファイル名、タイトル、パスをもとに解決され、リンク切れは警告されます。
• 04バックリンクとサイト全体のグラフ表示で、ページ間の関連を確認できます。
• 05他のページやセクション、PDF、画像をページに埋め込めます。
• 06Mermaidの図、KaTeXの数式、行のハイライトに対応したコードブロックをビルド時にレンダリングします。
• 07タグ、移動したページのエイリアス、gitの履歴に基づく最終更新日。

ユースケース

• Markdownのメモから、個人用のデジタルガーデンやナレッジベースを公開する。
• リンクと検索に対応したチーム内ドキュメントを構築する。
• 静的ファイルとしてデプロイできるプロジェクトWikiを作成する。
• CIでリンク切れをチェックしながら、相互にリンクした技術メモを管理する。

クイックスタート

1. 1

   新しいプロジェクトを作成する

   npx create-eziwiki my-docs
2. 2

   プロジェクトフォルダーに移動する

   cd my-docs
3. 3

   依存関係をインストールする

   npm install
4. 4

   開発サーバーを起動して http://localhost:3000 を開く

   npm run dev

使う前に知っておきたいこと

• !Node.js 22.13 以降が必要です。
• !バージョン 1.0 より前は、設定キー、frontmatter フィールド、または設定がリリースごとに変更される場合があります。また、更新するには engine ディレクトリを手動でコピーする必要があります。

収録されている特集

トピック

よくある質問

eziwiki とは？

検索、Wikiリンク、バックリンク、グラフ表示に対応した、Next.js製のMarkdown Wiki・ドキュメント生成ツール。静的ファイルを出力します。 EziWikiは、Markdownファイルのフォルダから静的なWikiサイトを生成します。content/以下の各.mdファイルが公開ページになり、フォルダはサイドバーのセクションになります。名前や順序を手動で指定したい場合を除き、ナビゲーション用の配列は不要です。

eziwiki は無料で使えますか？ライセンスは？

eziwiki は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

eziwiki は今もメンテナンスされていますか？

活発にメンテナンス中。eziwiki の最終コミットは 2026年11月2日 です。

eziwiki は何に使えますか？

Markdownのメモから、個人用のデジタルガーデンやナレッジベースを公開する。 リンクと検索に対応したチーム内ドキュメントを構築する。 静的ファイルとしてデプロイできるプロジェクトWikiを作成する。 CIでリンク切れをチェックしながら、相互にリンクした技術メモを管理する。

eziwiki のインストール方法は？

新しいプロジェクトを作成する: npx create-eziwiki my-docs プロジェクトフォルダーに移動する: cd my-docs 依存関係をインストールする: npm install 開発サーバーを起動して http://localhost:3000 を開く: npm run dev

eziwiki はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/i3months/eziwiki