このプロジェクトについて

SiYuanは、きめ細かなブロックレベルの参照とMarkdown WYSIWYG編集を中心に構築されたオープンソースでプライバシーファーストなパーソナルナレッジマネジメントシステムです。データは独自クラウドではなくワークスペースフォルダにローカル保存され、自己ホスト可能です。 READMEで確認できるコア機能には、ブロックレベル参照と双方向リンク、カスタム属性、埋め込みSQLクエリ、`siyuan://`プロトコルが含まれます。エディタはブロックスタイルで、Markdown WYSIWYG、リスト構成、ブロックズームイン、大規模文書のサポートを提供します。数式、チャート、フローチャート、ガントチャート、タイミングチャート、五線譜も扱い、ウェブクリッピングやPDF注釈リンクをサポートします。 エクスポートオプションとしては、ブロック参照と埋め込み、アセット付き標準Markdown、PDF、Word、HTML、WeChat MP・Zhihu・Yuqueへのコピーが含まれます。そのほか、テーブルビューデータベース、フラッシュカード間隔反復、OpenAI API経由のAI作成・Q&Aチャット、Tesseract OCR、マルチタブおよびドラッグ&ドロップ分割画面、テンプレートスニペット、JavaScript/CSSスニペット、コミュニティマーケットプレイスなどの機能があります。 デプロイメントパスとしては、デスクトップ・モバイルアプリ(Android、iOS、HarmonyOS)、パッケージマネージャー、Docker、Unraid、TrueNASが挙げられます。Dockerイメージ `b3log/siyuan` は、ワークスペースのマウント、ロックスクリーンパスワード、PUID/PGID権限、OIDC認証、言語設定をサポートします。組み込みCLIにより、ノートブック一覧、全文検索およびアセット検索、SQLクエリ、エクスポート・インポート、リポジトリ/履歴管理などに直接アクセスでき、JSON出力とドライランがサポートされています。 データはアセット、絵文字、スニペット、ストレージ、テンプレート、ウィジェット、プラグイン、公開データの各フォルダを含むワークスペースフォルダに保存され、ノートブック文書はJSON形式の`.sy`ファイルとして保存されます。READMEではデータ破損を避けるためサードパーティ製同期ディスクはサポートされていないものの、メンバー特典としてサードパーティ製クラウドストレージ接続が利用可能です。プロジェクトはAGPLv3ライセンスで提供され、商用利用を含む大半の機能は無料で提供されていますが、一部機能は有料会員に限定されています。