2024-10-18 10:54:36 +09:00
< p align = "center" >
< img alt = "SiYuan" src = "https://b3log.org/images/brand/siyuan-128.png" >
< br >
< em > あなたの思考をリファクタリングする< / em >
< br > < br >
< a title = "Build Status" target = "_blank" href = "https://github.com/siyuan-note/siyuan/actions/workflows/ci.yml" > < img src = "https://img.shields.io/github/actions/workflow/status/siyuan-note/siyuan/cd.yml?style=flat-square" > < / a >
< a title = "Releases" target = "_blank" href = "https://github.com/siyuan-note/siyuan/releases" > < img src = "https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=9CF" > < / a >
< a title = "Downloads" target = "_blank" href = "https://github.com/siyuan-note/siyuan/releases" > < img src = "https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet" > < / a >
< br >
< a title = "Docker Pulls" target = "_blank" href = "https://hub.docker.com/r/b3log/siyuan" > < img src = "https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=green" > < / a >
< a title = "Docker Image Size" target = "_blank" href = "https://hub.docker.com/r/b3log/siyuan" > < img src = "https://img.shields.io/docker/image-size/b3log/siyuan.svg?style=flat-square&color=ff96b4" > < / a >
< a title = "Hits" target = "_blank" href = "https://github.com/siyuan-note/siyuan" > < img src = "https://hits.b3log.org/siyuan-note/siyuan.svg" > < / a >
< br >
< a title = "AGPLv3" target = "_blank" href = "https://www.gnu.org/licenses/agpl-3.0.txt" > < img src = "http://img.shields.io/badge/license-AGPLv3-orange.svg?style=flat-square" > < / a >
< a title = "Code Size" target = "_blank" href = "https://github.com/siyuan-note/siyuan" > < img src = "https://img.shields.io/github/languages/code-size/siyuan-note/siyuan.svg?style=flat-square&color=yellow" > < / a >
< a title = "GitHub Pull Requests" target = "_blank" href = "https://github.com/siyuan-note/siyuan/pulls" > < img src = "https://img.shields.io/github/issues-pr-closed/siyuan-note/siyuan.svg?style=flat-square&color=FF9966" > < / a >
< br >
< a title = "GitHub Commits" target = "_blank" href = "https://github.com/siyuan-note/siyuan/commits/master" > < img src = "https://img.shields.io/github/commit-activity/m/siyuan-note/siyuan.svg?style=flat-square" > < / a >
< a title = "Last Commit" target = "_blank" href = "https://github.com/siyuan-note/siyuan/commits/master" > < img src = "https://img.shields.io/github/last-commit/siyuan-note/siyuan.svg?style=flat-square&color=FF9900" > < / a >
< br > < br >
< a title = "Twitter" target = "_blank" href = "https://twitter.com/b3logos" > < img alt = "Twitter Follow" src = "https://img.shields.io/twitter/follow/b3logos?label=Follow&style=social" > < / a >
< a title = "Discord" target = "_blank" href = "https://discord.gg/dmMbCqVX7G" > < img alt = "Chat on Discord" src = "https://img.shields.io/discord/808152298789666826?label=Discord&logo=Discord&style=social" > < / a >
< br > < br >
< a href = "https://www.producthunt.com/products/siyuan/reviews?utm_source=badge-product_rating&utm_medium=badge&utm_souce=badge-siyuan" target = "_blank" >< img src = "https://api.producthunt.com/widgets/embed-image/v1/product_rating.svg?product_id=534576&theme=light" alt = "SiYuan - A& #0032 ;privacy& #0045 ;first& #0032 ;personal& #0032 ;knowledge& #0032 ;management& #0032 ;software | Product Hunt" style = "width: 242px; height: 108px;" width = "242" height = "108" /></ a >
< / p >
< p align = "center" >
< a href = "README.md" > English< / a > | < a href = "README_zh_CN.md" > 中文< / a >
< / p >
---
## 目次
* [💡 紹介 ](#-紹介 )
* [🔮 特徴 ](#-特徴 )
* [🏗️ アーキテクチャとエコシステム ](#️ )
* [🌟 スター履歴 ](#-スター履歴 )
* [🗺️ ロードマップ ](#️ )
* [🚀 ダウンロードとセットアップ ](#-ダウンロードとセットアップ )
* [アプリマーケット ](#アプリマーケット )
* [インストールパッケージ ](#インストールパッケージ )
* [Docker ホスティング ](#docker-ホスティング )
* [Unraid ホスティング ](#unraid-ホスティング )
* [インサイダープレビュー ](#インサイダープレビュー )
* [🏘️ コミュニティ ](#️ )
* [🛠️ 開発ガイド ](#️ )
* [❓ FAQ ](#-faq )
* [SiYuanはどのようにデータを保存しますか？ ](#siyuanはどのようにデータを保存しますか )
* [サードパーティの同期ディスクを介したデータ同期をサポートしていますか？ ](#サードパーティの同期ディスクを介したデータ同期をサポートしていますか )
* [SiYuanはオープンソースですか？ ](#siyuanはオープンソースですか )
* [新しいバージョンにアップグレードするにはどうすればよいですか？ ](#新しいバージョンにアップグレードするにはどうすればよいですか )
* [一部のブロック（リスト項目内の段落ブロックなど）がブロックアイコンを見つけられない場合はどうすればよいですか？ ](#一部のブロックリスト項目内の段落ブロックなどがブロックアイコンを見つけられない場合はどうすればよいですか )
* [データリポジトリキーを紛失した場合はどうすればよいですか？ ](#データリポジトリキーを紛失した場合はどうすればよいですか )
* [支払いが必要ですか？ ](#支払いが必要ですか )
* [🙏 謝辞 ](#-謝辞 )
* [貢献者 ](#貢献者 )
---
## 💡 紹介
SiYuanは、プライバシーを最優先とする個人の知識管理システムであり、細かいブロックレベルの参照とMarkdown WYSIWYGをサポートしています。
詳細については、[SiYuan英語ディスカッションフォーラム ](https://liuyun.io )をご覧ください。
## 🔮 特徴
ほとんどの機能は無料で、商業利用も可能です。
* コンテンツブロック
* ブロックレベルの参照と双方向リンク
* カスタム属性
* SQLクエリ埋め込み
* プロトコル `siyuan://`
* エディタ
* ブロックスタイル
* Markdown WYSIWYG
* リストアウトライン
* ブロックズームイン
* 百万字の大規模ドキュメント編集
* 数学公式、チャート、フローチャート、ガントチャート、タイミングチャート、五線譜など
* ウェブクリッピング
* PDF注釈リンク
* エクスポート
* ブロック参照と埋め込み
* アセット付きの標準Markdown
* PDF、Word、HTML
* WeChat MP、Zhihu、Yuqueへのコピー
* データベース
* テーブルビュー
* フラッシュカード間隔反復
* OpenAI APIを介したAIライティングとQ/Aチャット
* Tesseract OCR
* マルチタブ、ドラッグアンドドロップで分割画面
* テンプレートスニペット
* JavaScript/CSSスニペット
2024-11-22 20:15:47 +08:00
* Android/iOS/HarmonyOSアプリ
2024-10-18 10:54:36 +09:00
* Dockerデプロイメント
* [API ](https://github.com/siyuan-note/siyuan/blob/master/API.md )
* コミュニティマーケットプレイス
一部の機能は有料会員のみ利用可能です。詳細については[価格 ](https://b3log.org/siyuan/en/pricing.html )をご覧ください。
## 🏗️ アーキテクチャとエコシステム
2024-11-22 20:15:47 +08:00
| プロジェクト | 説明 | フォーク | スター |
|----------------------------------------------------------|-----------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| [lute ](https://github.com/88250/lute ) | エディタエンジン |  |  |
| [chrome ](https://github.com/siyuan-note/siyuan-chrome ) | Chrome/Edge拡張 |  |  |
2024-10-18 10:54:36 +09:00
| [bazaar ](https://github.com/siyuan-note/bazaar ) | コミュニティマーケットプレイス |  |  |
2024-11-22 20:15:47 +08:00
| [dejavu ](https://github.com/siyuan-note/dejavu ) | データリポジトリ |  |  |
| [petal ](https://github.com/siyuan-note/petal ) | プラグインAPI |  |  |
| [android ](https://github.com/siyuan-note/siyuan-android ) | Androidアプリ |  |  |
| [ios ](https://github.com/siyuan-note/siyuan-ios ) | iOSアプリ |  |  |
| [harmony ](https://github.com/siyuan-note/siyuan-harmony ) | HarmonyOSアプリ |  |  |
| [riff ](https://github.com/siyuan-note/riff ) | 間隔反復 |  |  |
2024-10-18 10:54:36 +09:00
## 🌟 スター履歴
2024-10-22 16:33:49 +08:00
< a href = "https://star-history.com/ #siyuan -note/siyuan&Date" >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date&theme=dark" / >
< source media = "(prefers-color-scheme: light)" srcset = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date" / >
< img alt = "Star History Chart" src = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date" / >
< / picture >
< / a >
2024-10-18 10:54:36 +09:00
## 🗺️ ロードマップ
* [SiYuanの開発計画と進捗 ](https://github.com/orgs/siyuan-note/projects/1 )
* [SiYuanの変更履歴 ](CHANGELOG.md )
## 🚀 ダウンロードとセットアップ
デスクトップとモバイルでは、アプリマーケットからのインストールを優先的にお勧めします。これにより、将来的にワンクリックでバージョンをアップグレードできます。
### アプリマーケット
モバイル：
* [App Store ](https://apps.apple.com/us/app/siyuan/id1583226508 )
* [Google Play ](https://play.google.com/store/apps/details?id=org.b3log.siyuan )
* [F-Droid ](https://f-droid.org/packages/org.b3log.siyuan )
デスクトップ：
* [Microsoft Store ](https://apps.microsoft.com/detail/9p7hpmxp73k4 )
### インストールパッケージ
* [B3log ](https://b3log.org/siyuan/en/download.html )
* [GitHub ](https://github.com/siyuan-note/siyuan/releases )
### Docker ホスティング
< details >
< summary > Dockerデプロイメント< / summary >
#### 概要
サーバーでSiYuanを提供する最も簡単な方法は、Dockerを使用してデプロイすることです。
* イメージ名 `b3log/siyuan`
* [イメージURL ](https://hub.docker.com/r/b3log/siyuan )
#### ファイル構造
全体のプログラムは `/opt/siyuan/` にあり、基本的にはElectronインストールパッケージのresourcesフォルダーの構造です：
* appearance: アイコン、テーマ、言語
* guide: ユーザーガイドドキュメント
* stage: インターフェースと静的リソース
* kernel: カーネルプログラム
#### エントリポイント
エントリポイントはDockerイメージのビルド時に設定されます： `ENTRYPOINT ["/opt/siyuan/entrypoint.sh"]` 。このスクリプトを使用すると、コンテナ内で実行されるユーザーの `PUID` と `PGID` を変更できます。これは、ホストからディレクトリをマウントする際の権限の問題を解決するために特に重要です。`PUID` （ ） `PGID` （ ）
`docker run b3log/siyuan` を使用してコンテナを実行する場合、次のパラメータを使用します：
* `--workspace` : ワークスペースフォルダーのパスを指定し、ホスト上で `-v` を使用してコンテナにマウントします
* `--accessAuthCode` : アクセス認証コードを指定します
詳細なパラメータは `--help` を参照してください。以下は新しい環境変数を使用した起動コマンドの例です：
```bash
docker run -d \
-v workspace_dir_host:workspace_dir_container \
-p 6806:6806 \
-e PUID=1001 -e PGID=1002 \
b3log/siyuan \
--workspace=workspace_dir_container \
--accessAuthCode=xxx
```
* `PUID` : カスタムユーザーID（ `1000` ）
* `PGID` : カスタムグループID（ `1000` ）
* `workspace_dir_host` : ホスト上のワークスペースフォルダーのパス
* `workspace_dir_container` : コンテナ内のワークスペースフォルダーのパス、`--workspace` で指定されたものと同じ
* `accessAuthCode` : アクセス認証コード（**必ず変更してください**、そうしないと誰でもデータにアクセスできます）
簡略化するために、ホストとコンテナでワークスペースフォルダーのパスを一致させることをお勧めします。たとえば、`workspace_dir_host` と `workspace_dir_container` の両方を `/siyuan/workspace` に設定します。対応する起動コマンドは次のようになります：
```bash
docker run -d \
-v /siyuan/workspace:/siyuan/workspace \
-p 6806:6806 \
-e PUID=1001 -e PGID=1002 \
b3log/siyuan \
--workspace=/siyuan/workspace/ \
--accessAuthCode=xxx
```
#### Docker Compose
Docker Composeを使用してSiYuanを実行するユーザー向けに、環境変数 `PUID` と `PGID` を使用してユーザーとグループのIDをカスタマイズできます。以下はDocker Composeの設定例です：
```yaml
version: "3.9"
services:
main:
image: b3log/siyuan
command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
ports:
- 6806:6806
volumes:
- /siyuan/workspace:/siyuan/workspace
restart: unless-stopped
environment:
# タイムゾーン識別子のリストは https://en.wikipedia.org/wiki/List_of_tz_database_time_zones を参照してください
- TZ=${YOUR_TIME_ZONE}
- PUID=${YOUR_USER_PUID} # カスタムユーザーID
- PGID=${YOUR_USER_PGID} # カスタムグループID
```
この設定では：
* `PUID` と `PGID` は動的に設定され、コンテナに渡されます
* これらの変数が提供されていない場合、デフォルトの `1000` が使用されます
環境で `PUID` と `PGID` を指定することで、composeファイルで `user` ディレクティブ（`user: '1000:1000'` ）を明示的に設定する必要がなくなります。コンテナは起動時にこれらの環境変数に基づいてユーザーとグループを動的に調整します。
#### ユーザー権限
イメージ内で、`entrypoint.sh` スクリプトは指定された `PUID` と `PGID` で `siyuan` ユーザーとグループを作成することを保証します。したがって、ホストがワークスペースフォルダーを作成する際には、フォルダーのユーザーとグループの所有権を設定し、使用する予定の `PUID` と `PGID` に一致させることに注意してください。たとえば：
```bash
chown -R 1001:1002 /siyuan/workspace
```
カスタムの `PUID` と `PGID` 値を使用する場合、エントリポイントスクリプトはコンテナ内で正しいユーザーとグループを作成し、マウントされたボリュームの所有権を適切に調整します。`docker run` または `docker-compose` で `-u` を手動で渡す必要はありません。環境変数がカスタマイズを処理します。
#### 隠しポート
NGINXリバースプロキシを使用してポート6806を隠します。注意点：
* WebSocketリバースプロキシ `/ws` を設定します
#### 注意
* マウントボリュームの正確性を確認してください。そうしないと、コンテナが削除された後にデータが失われます
* URLリライトを使用してリダイレクトしないでください。認証に問題が発生する可能性があるため、リバースプロキシの設定をお勧めします
* 権限の問題が発生した場合、`PUID` と `PGID` 環境変数がホストシステム上のマウントされたディレクトリの所有権と一致していることを確認してください
#### 制限
* デスクトップおよびモバイルアプリケーションの接続はサポートされておらず、ブラウザでの使用のみサポートされています
* PDF、HTML、Word形式へのエクスポートはサポートされていません
* Markdownファイルのインポートはサポートされていません
< / details >
### Unraid ホスティング
< details >
< summary > Unraidデプロイメント< / summary >
注意：最初にターミナルで `chown -R 1000:1000 /mnt/user/appdata/siyuan` を実行します
テンプレートの参考：
```
Web UI: 6806
Container Port: 6806
Container Path: /home/siyuan
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
Publish parameters: --accessAuthCode=******（アクセス認証コード）
```
< / details >
### インサイダープレビュー
主要な更新前にインサイダープレビューをリリースします。詳細は[https://github.com/siyuan-note/insider ](https://github.com/siyuan-note/insider )をご覧ください。
## 🏘️ コミュニティ
* [英語ディスカッションフォーラム ](https://liuyun.io )
* [ユーザーコミュニティのまとめ ](https://liuyun.io/article/1687779743723 )
* [Awesome SiYuan ](https://github.com/siyuan-note/awesome )
## 🛠️ 開発ガイド
[開発ガイド ](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING.md )をご覧ください。
## ❓ FAQ
### SiYuanはどのようにデータを保存しますか？
データはワークスペースフォルダーに保存され、ワークスペースデータフォルダーに保存されます：
* `assets` はすべての挿入されたアセットを保存するために使用されます
* `emojis` は絵文字画像を保存するために使用されます
* `snippets` はコードスニペットを保存するために使用されます
* `storage` はクエリ条件、レイアウト、フラッシュカードなどを保存するために使用されます
* `templates` はテンプレートスニペットを保存するために使用されます
* `widgets` はウィジェットを保存するために使用されます
* `plugins` はプラグインを保存するために使用されます
* `public` は公開データを保存するために使用されます
* 残りのフォルダーはユーザーが作成したノートブックフォルダーであり、ノートブックフォルダー内の `.sy` サフィックスのファイルはドキュメントデータを保存するために使用され、データ形式はJSONです
### サードパーティの同期ディスクを介したデータ同期をサポートしていますか？
サードパーティの同期ディスクを介したデータ同期はサポートされていません。そうしないとデータが破損する可能性があります。
サードパーティの同期ディスクをサポートしていない場合でも、サードパーティのクラウドストレージと接続することはサポートされています（会員特典）。
また、データのエクスポートとインポートを手動で行うことでデータ同期を実現することもできます：
* デスクトップ：< kbd > 設定</ kbd > - < kbd > エクスポート</ kbd > - < kbd > データのエクスポート</ kbd > / < kbd > データのインポート</ kbd >
* モバイル：< kbd > 右カラム</ kbd > - < kbd > 情報</ kbd > - < kbd > データのエクスポート</ kbd > / < kbd > データのインポート</ kbd >
### SiYuanはオープンソースですか？
SiYuanは完全にオープンソースであり、貢献を歓迎します：
* [ユーザーインターフェースとカーネル ](https://github.com/siyuan-note/siyuan )
* [Android ](https://github.com/siyuan-note/siyuan-android )
* [iOS ](https://github.com/siyuan-note/siyuan-ios )
2024-11-22 20:15:47 +08:00
* [harmony ](https://github.com/siyuan-note/siyuan-harmony )
2024-10-18 10:54:36 +09:00
* [Chromeクリッピング拡張 ](https://github.com/siyuan-note/siyuan-chrome )
詳細については[開発ガイド ](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING.md )をご覧ください。
### 新しいバージョンにアップグレードするにはどうすればよいですか？
* アプリストアからインストールした場合は、アプリストアから更新してください
* デスクトップでインストールパッケージを使用してインストールした場合は、< kbd > 設定</ kbd > - < kbd > 情報</ kbd > - < kbd > 自動的に更新インストールパッケージをダウンロード</ kbd > オプションを開くことができます。これにより、SiYuanは最新バージョンのインストールパッケージを自動的にダウンロードし、インストールを促します
* 手動でインストールパッケージを使用してインストールした場合は、再度インストールパッケージをダウンロードしてインストールしてください
< kbd > 設定</ kbd > - < kbd > 情報</ kbd > - < kbd > 現在のバージョン</ kbd > で < kbd > 更新を確認</ kbd > できます。また、[公式ダウンロード ](https://b3log.org/siyuan/en/download.html ) または [GitHub Releases ](https://github.com/siyuan-note/siyuan/releases ) をフォローして新しいバージョンを入手することもできます。
### 一部のブロック（リスト項目内の段落ブロックなど）がブロックアイコンを見つけられない場合はどうすればよいですか？
リスト項目の最初のサブブロックはブロックアイコンが省略されています。このブロックにカーソルを移動し、< kbd > Ctrl+/< / kbd > を使用してそのブロックメニューをトリガーできます。
### データリポジトリキーを紛失した場合はどうすればよいですか？
* データリポジトリキーが以前に複数のデバイスで正しく初期化されている場合、キーはすべてのデバイスで同じであり、< kbd > 設定</ kbd > - < kbd > 情報</ kbd > - < kbd > データリポジトリキー</ kbd > - < kbd > キー文字列をコピー</ kbd > で見つけることができます
* 以前に正しく構成されていない場合（たとえば、複数のデバイスでキーが一致しない場合）またはすべてのデバイスが使用できず、キー文字列を取得できない場合は、以下の手順でキーをリセットできます：
1. データを手動でバックアップします。< kbd > データのエクスポート</ kbd > を使用するか、ファイルシステム上で < kbd > ワークスペース/data/</ kbd > フォルダーをコピーします
2. < kbd > 設定</ kbd > - < kbd > 情報</ kbd > - < kbd > データリポジトリキー</ kbd > - < kbd > データリポジトリをリセット</ kbd >
3. データリポジトリキーを再初期化します。1台のデバイスでキーを初期化した後、他のデバイスでキーをインポートします
4. クラウドは新しい同期ディレクトリを使用します。古い同期ディレクトリは使用できなくなり、削除できます
5. 既存のクラウドスナップショットは使用できなくなり、削除できます
### 支払いが必要ですか？
ほとんどの機能は無料で、商業利用も可能です。
会員特典は支払い後にのみ利用可能です。詳細については[価格 ](https://b3log.org/siyuan/en/pricing.html )をご覧ください。
## 🙏 謝辞
SiYuanの誕生は、多くのオープンソースプロジェクトと貢献者なしでは実現できませんでした。プロジェクトのソースコード kernel/go.mod、app/package.json、およびプロジェクトのホームページをご覧ください。
SiYuanの成長は、ユーザーのフィードバックとプロモーションなしでは実現できませんでした。SiYuanへのすべての支援に感謝します ❤️
### 貢献者
私たちに参加し、一緒にSiYuanにコードを貢献することを歓迎します。
< a href = "https://github.com/siyuan-note/siyuan/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=siyuan-note/siyuan" / >
< / a >
