mirror of
https://github.com/org-roam/org-roam
synced 2025-08-15 13:23:32 -05:00
Deploying to gh-pages from @ 50cc81c76d
🚀
This commit is contained in:
@@ -69,7 +69,7 @@ Next: <a href="Spaced-Repetition.html#Spaced-Repetition" accesskey="n" rel="next
|
|||||||
<a name="Bibliography-1"></a>
|
<a name="Bibliography-1"></a>
|
||||||
<h4 class="unnumberedsubsubsec">Bibliography</h4>
|
<h4 class="unnumberedsubsubsec">Bibliography</h4>
|
||||||
|
|
||||||
<p><a href="https://github.com/zaeph/org-roam-bibtex">org-roam-bibtex</a> offers
|
<p><a href="https://github.com/org-roam/org-roam-bibtex">org-roam-bibtex</a> offers
|
||||||
tight integration between
|
tight integration between
|
||||||
<a href="https://github.com/jkitchin/org-ref">org-ref</a>,
|
<a href="https://github.com/jkitchin/org-ref">org-ref</a>,
|
||||||
<a href="https://github.com/tmalsburg/helm-bibtex">helm-bibtex</a> and
|
<a href="https://github.com/tmalsburg/helm-bibtex">helm-bibtex</a> and
|
||||||
|
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
|
|||||||
<a name="FAQ"></a>
|
<a name="FAQ"></a>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="_005f-_00282_0029.html#g_t_005f-_00282_0029" accesskey="n" rel="next">_ (2)</a>, Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Next: <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="n" rel="next">_ (1)</a>, Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="FAQ-1"></a>
|
<a name="FAQ-1"></a>
|
||||||
|
@@ -25,7 +25,7 @@ General Public License for more details.
|
|||||||
<link href="index.html#Top" rel="start" title="Top">
|
<link href="index.html#Top" rel="start" title="Top">
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="FAQ.html#FAQ" rel="up" title="FAQ">
|
<link href="FAQ.html#FAQ" rel="up" title="FAQ">
|
||||||
<link href="_005f-_00282_0029.html#g_t_005f-_00282_0029" rel="next" title="_ (2)">
|
<link href="_005f-_00281_0029.html#g_t_005f-_00281_0029" rel="next" title="_ (1)">
|
||||||
<link href="FAQ.html#FAQ" rel="prev" title="FAQ">
|
<link href="FAQ.html#FAQ" rel="prev" title="FAQ">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
|
@@ -26,7 +26,7 @@ General Public License for more details.
|
|||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
|
<link href="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
|
||||||
<link href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" rel="next" title="The roam-file protocol">
|
<link href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" rel="next" title="The roam-file protocol">
|
||||||
<link href="_005f-_00281_0029.html#g_t_005f-_00281_0029" rel="prev" title="_ (1)">
|
<link href="_005f.html#g_t_005f" rel="prev" title="_">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
a.summary-letter {text-decoration: none}
|
a.summary-letter {text-decoration: none}
|
||||||
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
|
|||||||
<a name="Installation-_00281_0029"></a>
|
<a name="Installation-_00281_0029"></a>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The ‘<samp>roam-file</samp>’ protocol</a>, Previous: <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="p" rel="prev">_ (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The ‘<samp>roam-file</samp>’ protocol</a>, Previous: <a href="_005f.html#g_t_005f" accesskey="p" rel="prev">_</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="Installation-2"></a>
|
<a name="Installation-2"></a>
|
||||||
@@ -188,7 +188,7 @@ the default handler instead, run:
|
|||||||
<hr>
|
<hr>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The ‘<samp>roam-file</samp>’ protocol</a>, Previous: <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="p" rel="prev">_ (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The ‘<samp>roam-file</samp>’ protocol</a>, Previous: <a href="_005f.html#g_t_005f" accesskey="p" rel="prev">_</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
@@ -25,7 +25,7 @@ General Public License for more details.
|
|||||||
<link href="index.html#Top" rel="start" title="Top">
|
<link href="index.html#Top" rel="start" title="Top">
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="index.html#Top" rel="up" title="Top">
|
<link href="index.html#Top" rel="up" title="Top">
|
||||||
<link href="_005f.html#g_t_005f" rel="next" title="_">
|
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="next" title="Installing from MELPA">
|
||||||
<link href="Introduction.html#Introduction" rel="prev" title="Introduction">
|
<link href="Introduction.html#Introduction" rel="prev" title="Introduction">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
@@ -69,14 +69,15 @@ Next: <a href="Getting-Started.html#Getting-Started" accesskey="n" rel="next">Ge
|
|||||||
<a name="Installation-1"></a>
|
<a name="Installation-1"></a>
|
||||||
<h2 class="chapter">2 Installation</h2>
|
<h2 class="chapter">2 Installation</h2>
|
||||||
|
|
||||||
|
<p>Org-roam can be installed using Emacs’ package manager or manually from its
|
||||||
|
development repository.
|
||||||
|
</p>
|
||||||
<table class="menu" border="0" cellspacing="0">
|
<table class="menu" border="0" cellspacing="0">
|
||||||
<tr><td align="left" valign="top">• <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="1">Installing from MELPA</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="2">Installing from MELPA</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="2">Installing from the Git Repository</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="3">Installing from the Git Repository</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="3">Post-Installation Tasks</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
|
||||||
<tr><td align="left" valign="top">• <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="4">Post-Installation Tasks</a>:</td><td> </td><td align="left" valign="top">
|
|
||||||
</td></tr>
|
</td></tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
|
@@ -26,7 +26,7 @@ General Public License for more details.
|
|||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="Installation.html#Installation" rel="up" title="Installation">
|
<link href="Installation.html#Installation" rel="up" title="Installation">
|
||||||
<link href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" rel="next" title="Installing from the Git Repository">
|
<link href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" rel="next" title="Installing from the Git Repository">
|
||||||
<link href="_005f.html#g_t_005f" rel="prev" title="_">
|
<link href="Installation.html#Installation" rel="prev" title="Installation">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
a.summary-letter {text-decoration: none}
|
a.summary-letter {text-decoration: none}
|
||||||
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
|
|||||||
<a name="Installing-from-MELPA"></a>
|
<a name="Installing-from-MELPA"></a>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Previous: <a href="_005f.html#g_t_005f" accesskey="p" rel="prev">_</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="Installing-from-MELPA-1"></a>
|
<a name="Installing-from-MELPA-1"></a>
|
||||||
<h3 class="section">2.2 Installing from MELPA</h3>
|
<h3 class="section">2.1 Installing from MELPA</h3>
|
||||||
|
|
||||||
<p>Org-roam is available from Melpa and Melpa-Stable. If you haven’t used Emacs’ package manager before, you may familiarize yourself with it by reading the documentation in the Emacs manual, see info:emacs#Packages. Then, add one of the archives to ‘<samp>package-archives</samp>’:
|
<p>Org-roam is available from Melpa and Melpa-Stable. If you haven’t used Emacs’ package manager before, you may familiarize yourself with it by reading the documentation in the Emacs manual, see info:emacs#Packages. Then, add one of the archives to ‘<samp>package-archives</samp>’:
|
||||||
</p>
|
</p>
|
||||||
|
@@ -67,7 +67,7 @@ Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" acc
|
|||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="TODO-Installing-from-the-Git-Repository"></a>
|
<a name="TODO-Installing-from-the-Git-Repository"></a>
|
||||||
<h3 class="section">2.3 <strong>TODO</strong> Installing from the Git Repository</h3>
|
<h3 class="section">2.2 <strong>TODO</strong> Installing from the Git Repository</h3>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@@ -66,8 +66,16 @@ ul.no-bullet {list-style: none}
|
|||||||
Previous: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="p" rel="prev">Installing from the Git Repository</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Previous: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="p" rel="prev">Installing from the Git Repository</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="TODO-Post_002dInstallation-Tasks"></a>
|
<a name="Post_002dInstallation-Tasks-1"></a>
|
||||||
<h3 class="section">2.4 <strong>TODO</strong> Post-Installation Tasks</h3>
|
<h3 class="section">2.3 Post-Installation Tasks</h3>
|
||||||
|
|
||||||
|
<p>Org-roam uses <code>emacsql-sqlite3</code>, which requires <code>sqlite3</code> to be located on
|
||||||
|
<code>exec-path</code>. Please ensure that <code>sqlite3</code> is installed appropriately on your
|
||||||
|
operating system. You can verify that this is the case by executing:
|
||||||
|
</p>
|
||||||
|
<div class="lisp">
|
||||||
|
<pre class="lisp">(executable-find "sqlite3")
|
||||||
|
</pre></div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@@ -25,7 +25,7 @@ General Public License for more details.
|
|||||||
<link href="index.html#Top" rel="start" title="Top">
|
<link href="index.html#Top" rel="start" title="Top">
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="index.html#Top" rel="up" title="Top">
|
<link href="index.html#Top" rel="up" title="Top">
|
||||||
<link href="_005f-_00281_0029.html#g_t_005f-_00281_0029" rel="next" title="_ (1)">
|
<link href="_005f.html#g_t_005f" rel="next" title="_">
|
||||||
<link href="Org_002droam-Completion-System.html#Org_002droam-Completion-System" rel="prev" title="Org-roam Completion System">
|
<link href="Org_002droam-Completion-System.html#Org_002droam-Completion-System" rel="prev" title="Org-roam Completion System">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
@@ -70,7 +70,7 @@ Next: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-File
|
|||||||
<h2 class="chapter">11 Roam Protocol</h2>
|
<h2 class="chapter">11 Roam Protocol</h2>
|
||||||
|
|
||||||
<table class="menu" border="0" cellspacing="0">
|
<table class="menu" border="0" cellspacing="0">
|
||||||
<tr><td align="left" valign="top">• <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="1">_</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="2">Installation</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="2">Installation</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
|
@@ -24,9 +24,8 @@ General Public License for more details.
|
|||||||
<meta name="Generator" content="makeinfo">
|
<meta name="Generator" content="makeinfo">
|
||||||
<link href="index.html#Top" rel="start" title="Top">
|
<link href="index.html#Top" rel="start" title="Top">
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
|
<link href="index.html#Top" rel="up" title="Top">
|
||||||
<link href="Installation-_00281_0029.html#Installation-_00281_0029" rel="next" title="Installation (1)">
|
<link href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f" rel="prev" title="How do I have more than one Org-roam directory?">
|
||||||
<link href="Roam-Protocol.html#Roam-Protocol" rel="prev" title="Roam Protocol">
|
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
a.summary-letter {text-decoration: none}
|
a.summary-letter {text-decoration: none}
|
||||||
@@ -63,17 +62,15 @@ ul.no-bullet {list-style: none}
|
|||||||
<a name="g_t_005f-_00281_0029"></a>
|
<a name="g_t_005f-_00281_0029"></a>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="n" rel="next">Installation (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Previous: <a href="FAQ.html#FAQ" accesskey="p" rel="prev">FAQ</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="g_t_005f-_003aignore_003a-1"></a>
|
<a name="g_t_005f-_003aignore_003a-1"></a>
|
||||||
<h3 class="section">11.1 _ :ignore:</h3>
|
<h2 class="chapter">15 _ :ignore:</h2>
|
||||||
|
|
||||||
<p>Org-roam extending ‘<samp>org-protocol</samp>’ with 2 protocols: the ‘<samp>roam-file</samp>’
|
<p>Emacs 28.0.50 (Org mode 9.4)
|
||||||
and ‘<samp>roam-ref</samp>’ protocol.
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
@@ -1,76 +0,0 @@
|
|||||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
||||||
<html>
|
|
||||||
<!-- Copyright (C) 2020-2020 Jethro Kuan <jethrokuan95@gmail.com>
|
|
||||||
|
|
||||||
You can redistribute this document and/or modify it under the terms
|
|
||||||
of the GNU General Public License as published by the Free Software
|
|
||||||
Foundation, either version 3 of the License, or (at your option) any
|
|
||||||
later version.
|
|
||||||
|
|
||||||
This document is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
||||||
General Public License for more details.
|
|
||||||
-->
|
|
||||||
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
|
|
||||||
<head>
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<title>_ (2) (Org-roam User Manual)</title>
|
|
||||||
|
|
||||||
<meta name="description" content="_ (2) (Org-roam User Manual)">
|
|
||||||
<meta name="keywords" content="_ (2) (Org-roam User Manual)">
|
|
||||||
<meta name="resource-type" content="document">
|
|
||||||
<meta name="distribution" content="global">
|
|
||||||
<meta name="Generator" content="makeinfo">
|
|
||||||
<link href="index.html#Top" rel="start" title="Top">
|
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
|
||||||
<link href="index.html#Top" rel="up" title="Top">
|
|
||||||
<link href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f" rel="prev" title="How do I have more than one Org-roam directory?">
|
|
||||||
<style type="text/css">
|
|
||||||
<!--
|
|
||||||
a.summary-letter {text-decoration: none}
|
|
||||||
blockquote.indentedblock {margin-right: 0em}
|
|
||||||
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
|
|
||||||
blockquote.smallquotation {font-size: smaller}
|
|
||||||
div.display {margin-left: 3.2em}
|
|
||||||
div.example {margin-left: 3.2em}
|
|
||||||
div.lisp {margin-left: 3.2em}
|
|
||||||
div.smalldisplay {margin-left: 3.2em}
|
|
||||||
div.smallexample {margin-left: 3.2em}
|
|
||||||
div.smalllisp {margin-left: 3.2em}
|
|
||||||
kbd {font-style: oblique}
|
|
||||||
pre.display {font-family: inherit}
|
|
||||||
pre.format {font-family: inherit}
|
|
||||||
pre.menu-comment {font-family: serif}
|
|
||||||
pre.menu-preformatted {font-family: serif}
|
|
||||||
pre.smalldisplay {font-family: inherit; font-size: smaller}
|
|
||||||
pre.smallexample {font-size: smaller}
|
|
||||||
pre.smallformat {font-family: inherit; font-size: smaller}
|
|
||||||
pre.smalllisp {font-size: smaller}
|
|
||||||
span.nolinebreak {white-space: nowrap}
|
|
||||||
span.roman {font-family: initial; font-weight: normal}
|
|
||||||
span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
||||||
ul.no-bullet {list-style: none}
|
|
||||||
-->
|
|
||||||
</style>
|
|
||||||
<link rel="stylesheet" type="text/css" href="assets/page.css">
|
|
||||||
|
|
||||||
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body lang="en">
|
|
||||||
<a name="g_t_005f-_00282_0029"></a>
|
|
||||||
<div class="header">
|
|
||||||
<p>
|
|
||||||
Previous: <a href="FAQ.html#FAQ" accesskey="p" rel="prev">FAQ</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<a name="g_t_005f-_003aignore_003a-2"></a>
|
|
||||||
<h2 class="chapter">15 _ :ignore:</h2>
|
|
||||||
|
|
||||||
<p>Emacs 28.0.50 (Org mode 9.4)
|
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
@@ -24,9 +24,9 @@ General Public License for more details.
|
|||||||
<meta name="Generator" content="makeinfo">
|
<meta name="Generator" content="makeinfo">
|
||||||
<link href="index.html#Top" rel="start" title="Top">
|
<link href="index.html#Top" rel="start" title="Top">
|
||||||
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
||||||
<link href="Installation.html#Installation" rel="up" title="Installation">
|
<link href="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
|
||||||
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="next" title="Installing from MELPA">
|
<link href="Installation-_00281_0029.html#Installation-_00281_0029" rel="next" title="Installation (1)">
|
||||||
<link href="Installation.html#Installation" rel="prev" title="Installation">
|
<link href="Roam-Protocol.html#Roam-Protocol" rel="prev" title="Roam Protocol">
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
<!--
|
<!--
|
||||||
a.summary-letter {text-decoration: none}
|
a.summary-letter {text-decoration: none}
|
||||||
@@ -63,13 +63,14 @@ ul.no-bullet {list-style: none}
|
|||||||
<a name="g_t_005f"></a>
|
<a name="g_t_005f"></a>
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="n" rel="next">Installing from MELPA</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
Next: <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="n" rel="next">Installation (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="g_t_005f-_003aignore_003a"></a>
|
<a name="g_t_005f-_003aignore_003a"></a>
|
||||||
<h3 class="section">2.1 _ :ignore:</h3>
|
<h3 class="section">11.1 _ :ignore:</h3>
|
||||||
|
|
||||||
<p>Org-roam can be installed using Emacs’ package manager or manually from its development repository.
|
<p>Org-roam extending ‘<samp>org-protocol</samp>’ with 2 protocols: the ‘<samp>roam-file</samp>’
|
||||||
|
and ‘<samp>roam-ref</samp>’ protocol.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
@@ -73,10 +73,9 @@ ul.no-bullet {list-style: none}
|
|||||||
<li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li>
|
<li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li>
|
||||||
<li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a>
|
<li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a>
|
||||||
<ul class="no-bullet">
|
<ul class="no-bullet">
|
||||||
<li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">2.1 _ :ignore:</a></li>
|
<li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">2.1 Installing from MELPA</a></li>
|
||||||
<li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">2.2 Installing from MELPA</a></li>
|
<li><a name="toc-TODO-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">2.2 <strong>TODO</strong> Installing from the Git Repository</a></li>
|
||||||
<li><a name="toc-TODO-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">2.3 <strong>TODO</strong> Installing from the Git Repository</a></li>
|
<li><a name="toc-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">2.3 Post-Installation Tasks</a></li>
|
||||||
<li><a name="toc-TODO-Post_002dInstallation-Tasks" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">2.4 <strong>TODO</strong> Post-Installation Tasks</a></li>
|
|
||||||
</ul></li>
|
</ul></li>
|
||||||
<li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">3 Getting Started</a></li>
|
<li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">3 Getting Started</a></li>
|
||||||
<li><a name="toc-Anatomy-of-an-Org_002droam-File-1" href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">4 Anatomy of an Org-roam File</a>
|
<li><a name="toc-Anatomy-of-an-Org_002droam-File-1" href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">4 Anatomy of an Org-roam File</a>
|
||||||
@@ -110,7 +109,7 @@ ul.no-bullet {list-style: none}
|
|||||||
<li><a name="toc-Org_002droam-Completion-System-1" href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">10 Org-roam Completion System</a></li>
|
<li><a name="toc-Org_002droam-Completion-System-1" href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">10 Org-roam Completion System</a></li>
|
||||||
<li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">11 Roam Protocol</a>
|
<li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">11 Roam Protocol</a>
|
||||||
<ul class="no-bullet">
|
<ul class="no-bullet">
|
||||||
<li><a name="toc-_005f-_003aignore_003a-1" href="_005f-_00281_0029.html#g_t_005f-_00281_0029">11.1 _ :ignore:</a></li>
|
<li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">11.1 _ :ignore:</a></li>
|
||||||
<li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">11.2 Installation</a></li>
|
<li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">11.2 Installation</a></li>
|
||||||
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">11.3 The ‘<samp>roam-file</samp>’ protocol</a></li>
|
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">11.3 The ‘<samp>roam-file</samp>’ protocol</a></li>
|
||||||
<li><a name="toc-The-roam_002dref-Protocol-1" href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">11.4 The ‘<samp>roam-ref</samp>’ Protocol</a></li>
|
<li><a name="toc-The-roam_002dref-Protocol-1" href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">11.4 The ‘<samp>roam-ref</samp>’ Protocol</a></li>
|
||||||
@@ -137,7 +136,7 @@ ul.no-bullet {list-style: none}
|
|||||||
<ul class="no-bullet">
|
<ul class="no-bullet">
|
||||||
<li><a name="toc-How-do-I-have-more-than-one-Org_002droam-directory_003f-1" href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f">14.1 How do I have more than one Org-roam directory?</a></li>
|
<li><a name="toc-How-do-I-have-more-than-one-Org_002droam-directory_003f-1" href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f">14.1 How do I have more than one Org-roam directory?</a></li>
|
||||||
</ul></li>
|
</ul></li>
|
||||||
<li><a name="toc-_005f-_003aignore_003a-2" href="_005f-_00282_0029.html#g_t_005f-_00282_0029">15 _ :ignore:</a></li>
|
<li><a name="toc-_005f-_003aignore_003a-1" href="_005f-_00281_0029.html#g_t_005f-_00281_0029">15 _ :ignore:</a></li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -197,7 +196,7 @@ General Public License for more details.
|
|||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="FAQ.html#FAQ">FAQ</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="FAQ.html#FAQ">FAQ</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="_005f-_00282_0029.html#g_t_005f-_00282_0029">_</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029">_</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
||||||
|
|
||||||
@@ -205,9 +204,7 @@ General Public License for more details.
|
|||||||
|
|
||||||
Installation
|
Installation
|
||||||
|
|
||||||
</pre></th></tr><tr><td align="left" valign="top">• <a href="_005f.html#g_t_005f">_</a>:</td><td> </td><td align="left" valign="top">
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
|
||||||
<tr><td align="left" valign="top">• <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td> </td><td align="left" valign="top">
|
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
@@ -261,7 +258,7 @@ Graphing
|
|||||||
|
|
||||||
Roam Protocol
|
Roam Protocol
|
||||||
|
|
||||||
</pre></th></tr><tr><td align="left" valign="top">• <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029">_</a>:</td><td> </td><td align="left" valign="top">
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="_005f.html#g_t_005f">_</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="Installation-_00281_0029.html#Installation-_00281_0029">Installation</a>:</td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="Installation-_00281_0029.html#Installation-_00281_0029">Installation</a>:</td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
|
16
org-roam.org
16
org-roam.org
@@ -55,9 +55,11 @@ Org-roam provides several benefits over other tooling:
|
|||||||
- Free and Open Source :: Org-roam is free and open-source, which means that if you feel unhappy with any part of Org-roam, you may choose to extend Org-roam, or open a PR.
|
- Free and Open Source :: Org-roam is free and open-source, which means that if you feel unhappy with any part of Org-roam, you may choose to extend Org-roam, or open a PR.
|
||||||
- Leverages the Org-mode ecosystem :: Over the years, Emacs and Org-mode has developed into a mature system for plain-text organization. Building upon Org-mode already puts Org-roam light-years ahead of many other solutions.
|
- Leverages the Org-mode ecosystem :: Over the years, Emacs and Org-mode has developed into a mature system for plain-text organization. Building upon Org-mode already puts Org-roam light-years ahead of many other solutions.
|
||||||
- Built on Emacs :: Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs.
|
- Built on Emacs :: Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs.
|
||||||
|
|
||||||
* Installation
|
* Installation
|
||||||
** _ :ignore:
|
|
||||||
Org-roam can be installed using Emacs' package manager or manually from its development repository.
|
Org-roam can be installed using Emacs' package manager or manually from its
|
||||||
|
development repository.
|
||||||
|
|
||||||
** Installing from MELPA
|
** Installing from MELPA
|
||||||
|
|
||||||
@@ -97,7 +99,15 @@ Now see [[*Post-Installation Tasks][Post-Installation Tasks]].
|
|||||||
|
|
||||||
** TODO Installing from the Git Repository
|
** TODO Installing from the Git Repository
|
||||||
|
|
||||||
** TODO Post-Installation Tasks
|
** Post-Installation Tasks
|
||||||
|
|
||||||
|
Org-roam uses ~emacsql-sqlite3~, which requires ~sqlite3~ to be located on
|
||||||
|
~exec-path~. Please ensure that ~sqlite3~ is installed appropriately on your
|
||||||
|
operating system. You can verify that this is the case by executing:
|
||||||
|
|
||||||
|
#+BEGIN_SRC emacs-lisp
|
||||||
|
(executable-find "sqlite3")
|
||||||
|
#+END_SRC
|
||||||
|
|
||||||
* Getting Started
|
* Getting Started
|
||||||
|
|
||||||
|
@@ -78,14 +78,13 @@ General Public License for more details.
|
|||||||
* Diagnosing and Repairing Files::
|
* Diagnosing and Repairing Files::
|
||||||
* Appendix::
|
* Appendix::
|
||||||
* FAQ::
|
* FAQ::
|
||||||
* _: _ (2).
|
* _: _ (1).
|
||||||
|
|
||||||
@detailmenu
|
@detailmenu
|
||||||
--- The Detailed Node Listing ---
|
--- The Detailed Node Listing ---
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
|
|
||||||
* _::
|
|
||||||
* Installing from MELPA::
|
* Installing from MELPA::
|
||||||
* Installing from the Git Repository::
|
* Installing from the Git Repository::
|
||||||
* Post-Installation Tasks::
|
* Post-Installation Tasks::
|
||||||
@@ -119,7 +118,7 @@ Graphing
|
|||||||
|
|
||||||
Roam Protocol
|
Roam Protocol
|
||||||
|
|
||||||
* _: _ (1).
|
* _::
|
||||||
* Installation: Installation (1).
|
* Installation: Installation (1).
|
||||||
* The @samp{roam-file} protocol::
|
* The @samp{roam-file} protocol::
|
||||||
* The @samp{roam-ref} Protocol::
|
* The @samp{roam-ref} Protocol::
|
||||||
@@ -179,18 +178,15 @@ Emacs is also a fantastic interface for editing text, and we can inherit many of
|
|||||||
@node Installation
|
@node Installation
|
||||||
@chapter Installation
|
@chapter Installation
|
||||||
|
|
||||||
|
Org-roam can be installed using Emacs' package manager or manually from its
|
||||||
|
development repository.
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* _::
|
|
||||||
* Installing from MELPA::
|
* Installing from MELPA::
|
||||||
* Installing from the Git Repository::
|
* Installing from the Git Repository::
|
||||||
* Post-Installation Tasks::
|
* Post-Installation Tasks::
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node _
|
|
||||||
@section _ :ignore:
|
|
||||||
|
|
||||||
Org-roam can be installed using Emacs' package manager or manually from its development repository.
|
|
||||||
|
|
||||||
@node Installing from MELPA
|
@node Installing from MELPA
|
||||||
@section Installing from MELPA
|
@section Installing from MELPA
|
||||||
|
|
||||||
@@ -238,7 +234,15 @@ Now see @ref{Post-Installation Tasks}.
|
|||||||
@section @strong{TODO} Installing from the Git Repository
|
@section @strong{TODO} Installing from the Git Repository
|
||||||
|
|
||||||
@node Post-Installation Tasks
|
@node Post-Installation Tasks
|
||||||
@section @strong{TODO} Post-Installation Tasks
|
@section Post-Installation Tasks
|
||||||
|
|
||||||
|
Org-roam uses @code{emacsql-sqlite3}, which requires @code{sqlite3} to be located on
|
||||||
|
@code{exec-path}. Please ensure that @code{sqlite3} is installed appropriately on your
|
||||||
|
operating system. You can verify that this is the case by executing:
|
||||||
|
|
||||||
|
@lisp
|
||||||
|
(executable-find "sqlite3")
|
||||||
|
@end lisp
|
||||||
|
|
||||||
@node Getting Started
|
@node Getting Started
|
||||||
@chapter Getting Started
|
@chapter Getting Started
|
||||||
@@ -840,13 +844,13 @@ Other options include @samp{'ido}, and @samp{'ivy}.
|
|||||||
@chapter Roam Protocol
|
@chapter Roam Protocol
|
||||||
|
|
||||||
@menu
|
@menu
|
||||||
* _: _ (1).
|
* _::
|
||||||
* Installation: Installation (1).
|
* Installation: Installation (1).
|
||||||
* The @samp{roam-file} protocol::
|
* The @samp{roam-file} protocol::
|
||||||
* The @samp{roam-ref} Protocol::
|
* The @samp{roam-ref} Protocol::
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node _ (1)
|
@node _
|
||||||
@section _ :ignore:
|
@section _ :ignore:
|
||||||
|
|
||||||
Org-roam extending @samp{org-protocol} with 2 protocols: the @samp{roam-file}
|
Org-roam extending @samp{org-protocol} with 2 protocols: the @samp{roam-file}
|
||||||
@@ -1238,7 +1242,7 @@ etc.) within Org-mode.
|
|||||||
@node Bibliography
|
@node Bibliography
|
||||||
@unnumberedsubsubsec Bibliography
|
@unnumberedsubsubsec Bibliography
|
||||||
|
|
||||||
@uref{https://github.com/zaeph/org-roam-bibtex, org-roam-bibtex} offers
|
@uref{https://github.com/org-roam/org-roam-bibtex, org-roam-bibtex} offers
|
||||||
tight integration between
|
tight integration between
|
||||||
@uref{https://github.com/jkitchin/org-ref, org-ref},
|
@uref{https://github.com/jkitchin/org-ref, org-ref},
|
||||||
@uref{https://github.com/tmalsburg/helm-bibtex, helm-bibtex} and
|
@uref{https://github.com/tmalsburg/helm-bibtex, helm-bibtex} and
|
||||||
@@ -1280,7 +1284,7 @@ All files within that directory will be treated as their own separate
|
|||||||
set of Org-roam files. Remember to run @samp{org-roam-db-build-cache} from a
|
set of Org-roam files. Remember to run @samp{org-roam-db-build-cache} from a
|
||||||
file within that directory, at least once.
|
file within that directory, at least once.
|
||||||
|
|
||||||
@node _ (2)
|
@node _ (1)
|
||||||
@chapter _ :ignore:
|
@chapter _ :ignore:
|
||||||
|
|
||||||
Emacs 28.0.50 (Org mode 9.4)
|
Emacs 28.0.50 (Org mode 9.4)
|
||||||
|
Reference in New Issue
Block a user