Repolode
Zavy86

Zavy86/WikiDocs

ページをポータブルなMarkdownファイルとして保存する、データベース不要のセルフホスト型Wiki。デスクトップアプリとDockerで利用できます。

代替できる製品:NotionConfluence

スター
533
フォーク
64
未解決の Issue
13
最終コミット
13 日前

これは何?

Wiki|Docsは、ナレッジベースをデータベースやクラウドサービスではなく、プレーンなMarkdownファイルとして管理したい人向けのWikiです。スタンドアロンのデスクトップアプリとして自分のコンピューター上だけで動かすことも、DockerでセルフホストしてWebクライアントからアクセスすることもできます。

ページはMarkdown構文、YAML frontmatter、KaTeXの数式、Mermaidの図に対応したWYSIWYGエディターで作成できます。ページの改訂履歴は無制限に保存でき、添付ファイルやクリップボードからの画像アップロード、名前空間によるコンテンツ整理にも対応しています。また、公開・非公開の閲覧モードを利用できます。デスクトップとリモートの同期機能により、ローカルで編集してセルフホスト環境に変更を反映できます。

このプロジェクトはSwaggerドキュメントページ付きのREST APIを提供しており、他のツールからコンテンツを読み書きできます。NestJSバックエンド、Angularクライアント、Electronデスクトップアプリを含むスタック全体でTypeScriptを採用しています。

主な機能

  • 01データベース不要で、ページをプレーンなMarkdownファイルとして保存
  • 02KaTeXの数式とMermaidの図に対応したWYSIWYGエディター
  • 03バージョン履歴付きでページの改訂を無制限に保存
  • 04デスクトップアプリとDockerによるセルフホストに対応し、デスクトップからリモート環境へ同期可能
  • 05Swaggerドキュメント付きのREST API
  • 06添付ファイル、クリップボードからの画像アップロード、名前空間による整理

ユースケース

  • 自分のコンピューターで個人用ナレッジベースを管理する
  • 自分のサーバーでチームやプロジェクトのWikiをホストする
  • LLMツールでも利用できるMarkdownファイルとしてドキュメントを保存する
  • コンテンツのポータビリティを保ちながら公開Wikiを運用する

クイックスタート

  1. 1

    ブラウザーで公開デモをお試しください

  2. 2

    リリースページからデスクトップアプリケーションをダウンロードして実行してください

  3. 3

    Dockerイメージを実行して、セルフホスト型のインスタンスを起動してください

    docker run -p 3210:3210 zavy86/wikidocs:2

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

  • バージョン1.xからアップグレードするには、ホームページのドキュメントをルートディレクトリに移動する手動の作業が必要です。
  • デバイス間で同期するには、リモートインスタンスを自分でホストする必要があります。

収録されている特集

トピック

よくある質問

WikiDocs とは?
ページをポータブルなMarkdownファイルとして保存する、データベース不要のセルフホスト型Wiki。デスクトップアプリとDockerで利用できます。 Wiki|Docsは、ナレッジベースをデータベースやクラウドサービスではなく、プレーンなMarkdownファイルとして管理したい人向けのWikiです。スタンドアロンのデスクトップアプリとして自分のコンピューター上だけで動かすことも、DockerでセルフホストしてWebクライアントからアクセスすることもできます。
WikiDocs は無料で使えますか?ライセンスは?
WikiDocs は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
WikiDocs は今もメンテナンスされていますか?
活発にメンテナンス中。WikiDocs の最終コミットは 2026年10月25日 です。
WikiDocs は何に使えますか?
自分のコンピューターで個人用ナレッジベースを管理する 自分のサーバーでチームやプロジェクトのWikiをホストする LLMツールでも利用できるMarkdownファイルとしてドキュメントを保存する コンテンツのポータビリティを保ちながら公開Wikiを運用する
WikiDocs のインストール方法は?
ブラウザーで公開デモをお試しください リリースページからデスクトップアプリケーションをダウンロードして実行してください Dockerイメージを実行して、セルフホスト型のインスタンスを起動してください: docker run -p 3210:3210 zavy86/wikidocs:2
WikiDocs はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/Zavy86/WikiDocs

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト