siyuan - 📕SiYuanは、ローカル初のパーソナルナレッジ管理システムであり、きめ細かいブロックレベルの参照とMarkdownWYSIWYGをサポートしています。ロードマップhttps://github.com/orgs/siyuan-note/projects/1

(📕 SiYuan is a local-first personal knowledge management system, supports fine-grained block-level reference, and Markdown WYSIWYG. Roadmap https://github.com/orgs/siyuan-note/projects/1)

Created at: 2020-08-30 17:21:35
Language: TypeScript
License: AGPL-3.0

SiYuan
永遠のデジタルガーデンを構築する

中文

💡序章

SiYuanは、ローカル初のパーソナルナレッジ管理システムであり、きめ細かいブロックレベルの参照とMarkdownWYSIWYGをサポートします。

feature0.png

feature1-1.png

✨特徴

無料

すべてのローカル機能は無料です。

  • コンテンツブロック
    • ブロックレベルの参照と双方向リンク
    • ドキュメント関係図、グローバル関係図
    • カスタム属性
    • SQLクエリの埋め込み
    • プロトコル
      siyuan://
  • 編集者
    • ブロックスタイル
    • マークダウンWYSIWYG
    • リスト概要
    • ズームインをブロックする
    • ブロック水平レイアウト
    • 百万語の大きな文書編集
    • 数式、チャート、フローチャート、ガントチャート、タイミングチャート、スタッフなど。
    • Webクリッピング
    • PDF注釈リンク
  • 書き出す
    • ブロック参照と埋め込み
    • 資産を含む標準値下げ
    • PDF、Word、HTML
    • WeChat MP、Zhihu、Yuqueにコピー
  • コミュニティバザー
    • テーマ
    • アイコン
    • テンプレート
    • ウィジェット
  • 階層タグ
  • マルチタブ、ドラッグアンドドロップで画面を分割
  • 全文検索
  • テンプレートスニペット
  • キーマップ
  • テーマとアイコン
  • Android APP
  • iOSアプリ
  • Dockerのデプロイ
  • API

有料サブスクリプション

クラウドサービスには有料のサブスクリプションが必要です。

  • VIPアイデンティティ
  • エンドツーエンドの暗号化されたデータ同期
  • エンドツーエンドの暗号化されたデータのバックアップ
  • 提供するクラウド資産
  • WeChat通知
  • クラウドの受信トレイ

🗺️ロードマップ

🛠️セットアップをダウンロード

将来的にワンクリックでバージョンをアップグレードできるように、デスクトップとモバイルのアプリケーション市場からのインストールを優先することをお勧めします。

アプリマーケット

Dockerホスティング

Dockerのデプロイ

概要

サーバー上でSiYuanを提供する最も簡単な方法は、Dockerを介してSiYuanをデプロイすることです。

ファイル構造

プログラム全体はの下

/opt/siyuan/
にあります。これは基本的に、Electronインストールパッケージのresourcesフォルダーの下にある構造です。

  • 外観:アイコン、テーマ、言語
  • ガイド:ユーザーガイドドキュメント
  • ステージ:インターフェースと静的リソース
  • カーネル:カーネルプログラム

エントリーポイント

Dockerイメージをビルドするときにエントリポイントが設定されます。、パラメータとともに

ENTRYPOINT ["/opt/siyuan/kernel" ]
使用して開始します。
docker run b3log/siyuan

  • --workspace
    specifies the workspace folder path, mounted to the container via
    -v
    on the host

More parameters can refer to

--help
. The following is an example of a startup command:
docker run -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container

  • workspace_dir_host
    : the workspace folder path on the host
  • workspace_dir_container
    : The path of the workspace folder in the container, which is the same as specified in
    --workspace

To simplify, it is recommended to configure the workspace folder path to be consistent on the host and container, such as:

workspace_dir_host
and
workspace_dir_container
are configured as
/siyuan/workspace
, the corresponding startup commands is:
docker run -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/
.

User permissions

siyuan
このイメージでは、デフォルトで作成された通常のユーザー(uid 1000 / gid 1000)がカーネルプロセスの開始に使用されます。したがって、ホストがワークスペースフォルダを作成するときは、フォルダのユーザーグループの設定に注意してください
chown -R 1000:1000 /siyuan/workspace
。このパラメーター
-u 1000:1000
は、コンテナーを開始するときに必要です。

隠しポート

NGINXリバースプロキシを使用してポート6806を非表示にします。次の点に注意してください。

  • WebSocketリバースプロキシを構成する
    /ws

インストールパッケージ

インサイダープレビュー

最新のInsiderPreviewを入手するには、GitHubのログイン名を記載したメールを845765@qq.comに送信してください。ありがとうございます。SiYuanInsiderPreviewチームにご招待します。

🏘️コミュニティ

❓よくある質問

SiYuanはどのようにデータを保存しますか?

データは、ワークスペースフォルダ(デフォルトはユーザーのホームディレクトリDocuments / SiYuanにあり、Settings-で変更できますAbout)のワークスペースデータフォルダに保存されます。

  • assets
    挿入されたすべてのアセットファイルを保存するために使用されます
  • templates
    テンプレートスニペットを保存するために使用されます
  • widgets
    ウィジェットを保存するために使用されます
  • emojis
    絵文字画像の保存に使用されます
  • 残りのフォルダーはユーザーが作成したノートブックフォルダーであり
    .sy
    、ノートブックフォルダー内の接尾辞がのファイルはドキュメントデータの保存に使用され、データ形式はJSONです。

SiYuanはオープンソースですか?

SiYuanは完全にオープンソースであり、貢献を歓迎します。

詳細については、開発ガイドを参照してください。

ドキュメントを削除するための注意事項はありますか?

削除後、ドキュメントはオペレーティングシステムのごみ箱に表示されませんが、直接削除されます。削除すると、SiYuanは編集履歴を生成します。

新しい段落を開始せずに、折り返すにはどうすればよいですか?

を使用してくださいShift+Enter。

見出しとその下のブロックを移動するにはどうすればよいですか?

見出しを折り、後で移動します。

ページ全体で複数のブロックを選択するにはどうすればよいですか?

Shiftページをスクロールした後、最初をクリックし、押したまま最後をクリックします。

見つけて交換するにはどうすればよいですか?

Ctrl+Rエディターでキーワードを選択してからを押します。

データ同期にサードパーティの同期ディスクを使用するにはどうすればよいですか?

  • 同期するだけで
    workspace/data/
    、ワークスペース全体を同期しないでください
  • SiYuanの動作中は、サードパーティの同期を一時停止してください。一時停止すると、データが破損する可能性があります。詳しくはこちらをご覧ください
  • Androidのデータフォルダパスはです
    internal storage device/Android/data/org.b3log.siyuan/files/siyuan/data/
    。これはアプリケーションのプライベートパスであり、他のプログラムで読み取ることはできず、手動でのみコピーできます。
  • サードパーティの同期とSiYuanの同期の間に競合があります。同時に使用しないでください

エンドツーエンドのパスワードを忘れた場合はどうすればよいですか?

  • メインデバイスで新しいワークスペースを使用し、古いワークスペースデータフォルダーを新しいワークスペースに手動でコピーします
  • 新しいワークスペースはパスワードをリセットできます
  • クラウドは新しいクラウド同期ディレクトリを使用します

モバイルエンドの場合は、アンインストールして再インストールします(注:モバイルエンドがアプリケーションをアンインストールすると、ローカルワークスペースデータが一緒に削除されます)。

お金を払う必要がありますか?

ローカル機能は完全に無料で使用できます。クラウドサービスには年間サブスクリプションが必要です。価格は年間72ドルです。

SiYuan Cloud Serverは中国本土以外の地域での可用性を保証できないため、中国本土以外の地域のユーザーはサブスクリプションの料金を支払うべきではありません。

💌貢献に参加する

SiYuanは完全にオープンソースであり、貢献を歓迎します。

詳細については、開発ガイドを参照してください。

🙏了承

SiYuanは、以下のオープンソースプロジェクトによって可能になりました。