org roam

org-roam

Org-Roamは、平易なテキストナレッジマネジメントシステムです。 Roamのより強力な機能のいくつかを組織モードのエコシステムにもたらします。

Org-Roamは、Zettelkastenメソッドから原則を借用し、非階層的なメモを取得するためのソリューションを提供します。また、個人WikiにOrg-Modeをすでに使用している人のためのプラグアンドプレイソリューションとしても機能するはずです。

• プライベートで安全：個人的なWikiを完全にオフラインで編集し、完全にコントロールしてください。 GPGでメモを暗号化します。プレーンテキストで永続的なメモを取ります。
• ネットワーク化された思考：バックリンクを使用して、メモと思考を簡単に接続します。組み込みのグラフの視覚化を使用して、メモで驚くべき、以前に見えなかった接続を発見してください。
• 拡張可能で強力：Emacsの素晴らしいテキスト編集インターフェイスを活用し、パッケージの成熟したEmacsとOrg-Modeエコシステム。
• 無料およびオープンソース：Org-Roamは、GNU General Public Licenseバージョン3以降でライセンスされています。

• ドキュメント
• 談話
• スラック
• よくある質問
• Changelog

インストール

下の下には、さまざまな目的でさまざまな環境を使用してorg-roamすばやくインストールする方法に関する基本的なインストール手順があります。詳細については、マニュアルをお読みください。

package.elを使用します

手順を切り替えます

package.elを使用して、MelpaまたはMelpa Stableからorg-roamをインストールできます。

 M-x package-install RET org-roam RET

straight.elを使用します

手順を切り替えます

straight.elを使用してMelpaまたはMelpa Stableからの設置：

( straight-use-package 'org-roam )

またはuse-packageで：

( use-package org-roam
  :straight t
  ...)

メルパからではなく、ソースリポジトリからパッケージを直接インストールする必要がある場合、次のサンプルはその方法を示しています。

( use-package org-roam
  :straight ( :host github :repo " org-roam/org-roam "
             :files ( :defaults " extensions/* " ))
  ...)

開発と貢献のために独自のローカルフォークを使用する予定がある場合、次のサンプルでは次のようになります。

( use-package org-roam
  :straight ( :local-repo " /path/to/org-roam-fork "
             :files ( :defaults " extensions/* " )
             :build ( :not compile))
  ...)

Doom Emacsを使用します

手順を切り替えます

Doom's :lang org Moduleにはorg-roamのサポートが付属していますが、デフォルトでは有効になっていません。 $DOOMDIR/init.el （eg (org +roam2) ）のorgモジュールに+roam2フラグを渡すには、ファイルを保存して、シェルでdoom sync -uを実行します。

より良い安定性を提供するために、Doomはパッケージを特定のコミットに固定します。あなたがそれを提示する必要がある場合（それを行うことをお勧めしません、代わりにパッケージをぶつけるようにDoomを要求します）、あなたのpackages.elで次のものを使用します.EL：

(unpin! org-roam)

何らかの理由で、 org-roamに別のレシピを使用する場合は、 packages.elの次のフォームを使用して、レシピリポジトリ（MELPAなど）からパッケージをインストールできます。

(package! org-roam)

渡すことができます:pin "commit hash"て、パッケージを特定のコミットに固定します。

次のサンプルを使用すると、ソースリポジトリから直接パッケージをインストールできます。

(package! org-roam
  :recipe ( :host github :repo " org-roam/org-roam "
           :files ( :defaults " extensions/* " )))

そして、開発や貢献のために独自のローカルフォークを使用する予定がある場合、次のサンプルでは次のようになります。

(package! org-roam
  :recipe ( :local-repo " /path/to/org-roam-fork "
           :files ( :defaults " extensions/* " )
           :build ( :not compile)))

パッケージマネージャーなし

手順を切り替えます

パッケージマネージャーを使用せずにパッケージをインストールするには、次の2つのオプションがあります。

1. ソースリポジトリからgitでクローン化してパッケージをインストールします。
2. または、最新リリースバージョンをダウンロードしてパッケージをインストールします。

どちらの場合も、必要なすべての依存関係があることを確認する必要があります。これらには以下が含まれます：

• ダッシュ
• f
• s
• org（9.4は最小限の必要なバージョンです！）
• emacsql
• emacsql-sqlite
• Magit-Section
• filenotify-precursive

パッケージをインストールした後、パッケージにload-pathを適切にセットアップする必要があります。

( add-to-list 'load-path " /path/to/org-roam/ " )
( add-to-list 'load-path " /path/to-org-roam/extensions/ " )

その後、問題なく解決できる(require 'org-roam)コールを解決できるはずです。

Org-Roamには、Emacsの組み込み情報システムと統合するための.texiファイルも付属しています。マニュアルを読んで、手動でインストールする方法については詳細を確認してください。

構成

use-packageを使用して、 org-roamの構成に関する非常に基本的なサンプルです。

( use-package org-roam
  :ensure t
  :custom
  (org-roam-directory ( file-truename " /path/to/org-files/ " ))
  :bind (( " C-c n l " . org-roam-buffer-toggle)
         ( " C-c n f " . org-roam-node-find)
         ( " C-c n g " . org-roam-graph)
         ( " C-c n i " . org-roam-node-insert)
         ( " C-c n c " . org-roam-capture)
         ; ; Dailies
         ( " C-c n j " . org-roam-dailies-capture-today))
  :config
  ; ; If you're using a vertical completion framework, you might want a more informative completion interface
  ( setq org-roam-node-display-template ( concat " ${title:*} " ( propertize " ${tags:10} " 'face 'org-tag )))
  (org-roam-db-autosync-mode)
  ; ; If using org-roam-protocol
  ( require 'org-roam-protocol ))

org-roam-directoryへのシンボリックリンクを使用する場合にのみfile-truename関数が必要であることに注意してください。 Org-Roamは、ディレクトリへのシンボリックリンクを自動的に解決しません。

はじめる

System CraftersのDavid Wilsonは、基本的なコマンドをカバーする入門ビデオを作成しました。

助けを得る

新しいトピック/問題を作成する前に、私たちの時間に注意し、GitHubや談話でまだ対処されていないことを確認してください。

• EMACSを初めて使用していて、Org-Roamのセットアップに問題がある場合は、Slack、Channel＃How-Do-Iで質問してください。
• 簡単な質問については、Slack、チャンネル#troubleshootingについて質問してください。
• 何かが機能していない場合、または新しい機能を提案したい場合は、新しい問題を作成してください。
• スリップボックスメソッドを使用してワークフローについて質問がある場合は、談話に関連するトピックを見つけたり、新しいトピックを作成したりしてください。

Org-Roamを使用した知識ベース

• ジェスロクアン（ソース）
• アレクセイ・シュマルコ
• シダース・アリア
• マーティン・エドストローム

貢献

バグを報告し、新機能を提案するには、問題トラッカーを使用します。マージしたいコードがある場合は、プルリクエストを開きます。 Converting.mdもご覧ください。

ライセンス

Copyright©Jethro Kuanと貢献者。 GNU General Public License、バージョン3に分配されます。