Deploying to gh-pages from @ 0aa0a7c05a 🚀

This commit is contained in:
jethrokuan
2020-07-30 18:16:17 +00:00
parent cd244a3697
commit a5a0b09b41
52 changed files with 290 additions and 108 deletions

View File

@@ -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="index.html#Top" rel="up" title="Top"> <link href="index.html#Top" rel="up" title="Top">
<link href="Installation.html#Installation" rel="next" title="Installation"> <link href="Installation.html#Installation" rel="next" title="Installation">
<link href="Introduction.html#Introduction" rel="prev" title="Introduction"> <link href="Target-Audience.html#Target-Audience" rel="prev" title="Target Audience">
<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="A-Brief-Introduction-to-the-Zettelkasten-Method"></a> <a name="A-Brief-Introduction-to-the-Zettelkasten-Method"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Target-Audience.html#Target-Audience" accesskey="p" rel="prev">Target Audience</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>
<hr> <hr>
<a name="A-Brief-Introduction-to-the-Zettelkasten-Method-1"></a> <a name="A-Brief-Introduction-to-the-Zettelkasten-Method-1"></a>
<h2 class="chapter">2 A Brief Introduction to the Zettelkasten Method</h2> <h2 class="chapter">3 A Brief Introduction to the Zettelkasten Method</h2>
<p>Org-roam provides utilities for maintaining a digital slip-box. This section <p>Org-roam provides utilities for maintaining a digital slip-box. This section
aims to provide a brief introduction to the &ldquo;slip-box&rdquo;, or &ldquo;Zettelkasten&rdquo; aims to provide a brief introduction to the &ldquo;slip-box&rdquo;, or &ldquo;Zettelkasten&rdquo;
@@ -115,7 +115,7 @@ addition of different templates to facilitate the creation of these notes.
<hr> <hr>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Target-Audience.html#Target-Audience" accesskey="p" rel="prev">Target Audience</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>

View File

@@ -67,7 +67,7 @@ Next: <a href="The-Templating-System.html#The-Templating-System" accesskey="n" r
</div> </div>
<hr> <hr>
<a name="Anatomy-of-an-Org_002droam-File-1"></a> <a name="Anatomy-of-an-Org_002droam-File-1"></a>
<h2 class="chapter">5 Anatomy of an Org-roam File</h2> <h2 class="chapter">6 Anatomy of an Org-roam File</h2>
<p>The bulk of Org-roam&rsquo;s functionality is built on top of vanilla <p>The bulk of Org-roam&rsquo;s functionality is built on top of vanilla
Org-mode. However, to support additional functionality, Org-roam adds Org-mode. However, to support additional functionality, Org-roam adds

View File

@@ -67,7 +67,7 @@ Next: <a href="FAQ.html#FAQ" accesskey="n" rel="next">FAQ</a>, Previous: <a href
</div> </div>
<hr> <hr>
<a name="Appendix-1"></a> <a name="Appendix-1"></a>
<h2 class="chapter">16 Appendix</h2> <h2 class="chapter">17 Appendix</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Next: <a href="Versioning-Notes.html#Versioning-Notes" accesskey="n" rel="next">
</div> </div>
<hr> <hr>
<a name="Browsing-History-with-winner_002dmode-1"></a> <a name="Browsing-History-with-winner_002dmode-1"></a>
<h4 class="subsection">16.2.1 Browsing History with winner-mode</h4> <h4 class="subsection">17.2.1 Browsing History with winner-mode</h4>
<p><code>winner-mode</code> is a global minor mode that allows one to undo and redo changes in the window configuration. It is included with GNU Emacs since version 20. <p><code>winner-mode</code> is a global minor mode that allows one to undo and redo changes in the window configuration. It is included with GNU Emacs since version 20.
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Navigating-Around.html#Navigating-Around" accesskey="n" rel="next
</div> </div>
<hr> <hr>
<a name="Concepts-and-Configuration-1"></a> <a name="Concepts-and-Configuration-1"></a>
<h2 class="chapter">7 Concepts and Configuration</h2> <h2 class="chapter">8 Concepts and Configuration</h2>
<p>The number of configuration options is deliberately kept small, to keep <p>The number of configuration options is deliberately kept small, to keep
the Org-roam codebase manageable. However, we attempt to accommodate as the Org-roam codebase manageable. However, we attempt to accommodate as

View File

@@ -67,7 +67,7 @@ Next: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-File
</div> </div>
<hr> <hr>
<a name="TODO-Daily-Notes"></a> <a name="TODO-Daily-Notes"></a>
<h2 class="chapter">13 <strong>TODO</strong> Daily Notes</h2> <h2 class="chapter">14 <strong>TODO</strong> Daily Notes</h2>

View File

@@ -67,7 +67,7 @@ Next: <a href="Performance-Optimization.html#Performance-Optimization" accesskey
</div> </div>
<hr> <hr>
<a name="Diagnosing-and-Repairing-Files-1"></a> <a name="Diagnosing-and-Repairing-Files-1"></a>
<h2 class="chapter">14 Diagnosing and Repairing Files</h2> <h2 class="chapter">15 Diagnosing and Repairing Files</h2>
<p>Org-roam provides a utility for diagnosing and repairing problematic files via <p>Org-roam provides a utility for diagnosing and repairing problematic files via
<code>org-roam-doctor</code>. By default, <code>org-roam-doctor</code> runs the check on the current <code>org-roam-doctor</code>. By default, <code>org-roam-doctor</code> runs the check on the current

View File

@@ -67,7 +67,7 @@ Next: <a href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer" accesskey="
</div> </div>
<hr> <hr>
<a name="Directories-and-Files-1"></a> <a name="Directories-and-Files-1"></a>
<h3 class="section">7.1 Directories and Files</h3> <h3 class="section">8.1 Directories and Files</h3>
<p>This section concerns the placement and creation of files. <p>This section concerns the placement and creation of files.
</p> </p>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" acc
</div> </div>
<hr> <hr>
<a name="Ecosystem-1"></a> <a name="Ecosystem-1"></a>
<h3 class="section">16.2 Ecosystem</h3> <h3 class="section">17.2 Ecosystem</h3>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" accesskey="1">Browsing History with winner-mode</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" accesskey="1">Browsing History with winner-mode</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Next: <a href="Graphing.html#Graphing" accesskey="n" rel="next">Graphing</a>, Pr
</div> </div>
<hr> <hr>
<a name="Encryption-1"></a> <a name="Encryption-1"></a>
<h2 class="chapter">9 Encryption</h2> <h2 class="chapter">10 Encryption</h2>
<p>One may wish to keep private, encrypted files. Org-roam supports encryption (via <p>One may wish to keep private, encrypted files. Org-roam supports encryption (via
GPG), which can be enabled for all new files by setting <code>org-roam-encrypt-files</code> GPG), which can be enabled for all new files by setting <code>org-roam-encrypt-files</code>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Graph-Options.html#Graph-Options" accesskey="p" rel="prev">Gr
</div> </div>
<hr> <hr>
<a name="Excluding-Nodes-and-Edges-1"></a> <a name="Excluding-Nodes-and-Edges-1"></a>
<h3 class="section">10.2 Excluding Nodes and Edges</h3> <h3 class="section">11.2 Excluding Nodes and Edges</h3>
<p>One may want to exclude certain files to declutter the graph. <p>One may want to exclude certain files to declutter the graph.
</p> </p>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</a>
</div> </div>
<hr> <hr>
<a name="FAQ-1"></a> <a name="FAQ-1"></a>
<h2 class="chapter">17 FAQ</h2> <h2 class="chapter">18 FAQ</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="1">How do I have more than one Org-roam directory?</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="1">How do I have more than one Org-roam directory?</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Previous: <a href="Tags.html#Tags" accesskey="p" rel="prev">Tags</a>, Up: <a hre
</div> </div>
<hr> <hr>
<a name="File-Refs-1"></a> <a name="File-Refs-1"></a>
<h3 class="section">5.3 File Refs</h3> <h3 class="section">6.3 File Refs</h3>
<p>Refs are unique identifiers for files. Each note can only have 1 ref. <p>Refs are unique identifiers for files. Each note can only have 1 ref.
For example, a note for a website may contain a ref: For example, a note for a website may contain a ref:

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002djournal.html#Org_002djournal" accesskey="n" rel="next">Or
</div> </div>
<hr> <hr>
<a name="Full_002dtext-search-interface-with-Deft-1"></a> <a name="Full_002dtext-search-interface-with-Deft-1"></a>
<h4 class="subsection">16.2.3 Full-text search interface with Deft</h4> <h4 class="subsection">17.2.3 Full-text search interface with Deft</h4>
<p><a href="https://jblevins.org/projects/deft/">Deft</a> provides a nice interface for browsing and filtering org-roam notes. <p><a href="https://jblevins.org/projects/deft/">Deft</a> provides a nice interface for browsing and filtering org-roam notes.
</p> </p>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Profiling-Key-Operations.html#Profiling-Key-Operations" acces
</div> </div>
<hr> <hr>
<a name="Garbage-Collection-1"></a> <a name="Garbage-Collection-1"></a>
<h3 class="section">15.2 Garbage Collection</h3> <h3 class="section">16.2 Garbage Collection</h3>
<p>During the cache-build process, Org-roam generates a lot of in-memory <p>During the cache-build process, Org-roam generates a lot of in-memory
data-structures (such as the Org file&rsquo;s AST), which are discarded after use. These structures are garbage collected at regular intervals (see <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Garbage-Collection.html#Garbage-Collection">(elisp)info:elisp#Garbage Collection</a>). data-structures (such as the Org file&rsquo;s AST), which are discarded after use. These structures are garbage collected at regular intervals (see <a href="https://www.gnu.org/software/emacs/manual/html_node/elisp/Garbage-Collection.html#Garbage-Collection">(elisp)info:elisp#Garbage Collection</a>).

View File

@@ -67,7 +67,7 @@ Next: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-F
</div> </div>
<hr> <hr>
<a name="Getting-Started-1"></a> <a name="Getting-Started-1"></a>
<h2 class="chapter">4 Getting Started</h2> <h2 class="chapter">5 Getting Started</h2>
<p>This short tutorial describes the essential commands used in Org-roam, to help <p>This short tutorial describes the essential commands used in Org-roam, to help
you get started. you get started.

View File

@@ -67,7 +67,7 @@ Next: <a href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges" accessk
</div> </div>
<hr> <hr>
<a name="Graph-Options-1"></a> <a name="Graph-Options-1"></a>
<h3 class="section">10.1 Graph Options</h3> <h3 class="section">11.1 Graph Options</h3>
<p>Graphviz provides many options for customizing the graph output, and Org-roam supports some of them. See <a href="https://graphviz.gitlab.io/_pages/doc/info/attrs.html">https://graphviz.gitlab.io/_pages/doc/info/attrs.html</a> for customizable options. <p>Graphviz provides many options for customizing the graph output, and Org-roam supports some of them. See <a href="https://graphviz.gitlab.io/_pages/doc/info/attrs.html">https://graphviz.gitlab.io/_pages/doc/info/attrs.html</a> for customizable options.
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-Syste
</div> </div>
<hr> <hr>
<a name="Graphing-1"></a> <a name="Graphing-1"></a>
<h2 class="chapter">10 Graphing</h2> <h2 class="chapter">11 Graphing</h2>
<p>Org-roam provides graphing capabilities to explore interconnections between <p>Org-roam provides graphing capabilities to explore interconnections between
notes. This is done by performing SQL queries and generating images using notes. This is done by performing SQL queries and generating images using

View File

@@ -67,7 +67,7 @@ Next: <a href="How-do-I-migrate-from-Roam-Research_003f.html#How-do-I-migrate-fr
</div> </div>
<hr> <hr>
<a name="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></a> <a name="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></a>
<h3 class="section">17.1 How do I have more than one Org-roam directory?</h3> <h3 class="section">18.1 How do I have more than one Org-roam directory?</h3>
<p>Emacs supports directory-local variables, allowing the value of <p>Emacs supports directory-local variables, allowing the value of
<code>org-roam-directory</code> to be different in different directories. It does this by <code>org-roam-directory</code> to be different in different directories. It does this by

View File

@@ -66,7 +66,7 @@ Previous: <a href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#
</div> </div>
<hr> <hr>
<a name="How-do-I-migrate-from-Roam-Research_003f-1"></a> <a name="How-do-I-migrate-from-Roam-Research_003f-1"></a>
<h3 class="section">17.2 How do I migrate from Roam Research?</h3> <h3 class="section">18.2 How do I migrate from Roam Research?</h3>
<p>Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided <a href="https://github.com/fabioberger/roam-migration">in the repository</a>. <p>Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided <a href="https://github.com/fabioberger/roam-migration">in the repository</a>.
</p> </p>

View File

@@ -67,7 +67,7 @@ Up: <a href="Navigating-Around.html#Navigating-Around" accesskey="u" rel="up">Na
</div> </div>
<hr> <hr>
<a name="Index-File-1"></a> <a name="Index-File-1"></a>
<h3 class="section">8.1 Index File</h3> <h3 class="section">9.1 Index File</h3>
<p>As your collection grows, you might want to create an index where you keep links <p>As your collection grows, you might want to create an index where you keep links
to your main files. to your main files.

View File

@@ -67,7 +67,7 @@ Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" acces
</div> </div>
<hr> <hr>
<a name="Installation-2"></a> <a name="Installation-2"></a>
<h3 class="section">12.2 Installation</h3> <h3 class="section">13.2 Installation</h3>
<p>To enable Org-roam&rsquo;s protocol extensions, you have to add the following to your init file: <p>To enable Org-roam&rsquo;s protocol extensions, you have to add the following to your init file:
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Getting-Started.html#Getting-Started" accesskey="n" rel="next">Ge
</div> </div>
<hr> <hr>
<a name="Installation-1"></a> <a name="Installation-1"></a>
<h2 class="chapter">3 Installation</h2> <h2 class="chapter">4 Installation</h2>
<p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its <p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its
development repository. development repository.

View File

@@ -67,7 +67,7 @@ Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-R
</div> </div>
<hr> <hr>
<a name="Installing-from-Apt-1"></a> <a name="Installing-from-Apt-1"></a>
<h3 class="section">3.2 Installing from Apt</h3> <h3 class="section">4.2 Installing from Apt</h3>
<p>Users of Debian 11 or later or Ubuntu 20.10 or later can simply install Org-roam <p>Users of Debian 11 or later or Ubuntu 20.10 or later can simply install Org-roam
using Apt: using Apt:

View File

@@ -67,7 +67,7 @@ Next: <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="n" rel="
</div> </div>
<hr> <hr>
<a name="Installing-from-MELPA-1"></a> <a name="Installing-from-MELPA-1"></a>
<h3 class="section">3.1 Installing from MELPA</h3> <h3 class="section">4.1 Installing from MELPA</h3>
<p>Org-roam is available from Melpa and Melpa-Stable. If you haven&rsquo;t used Emacs&rsquo; <p>Org-roam is available from Melpa and Melpa-Stable. If you haven&rsquo;t used Emacs&rsquo;
package manager before, you may familiarize yourself with it by reading the package manager before, you may familiarize yourself with it by reading the

View File

@@ -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">3.3 <strong>TODO</strong> Installing from the Git Repository</h3> <h3 class="section">4.3 <strong>TODO</strong> Installing from the Git Repository</h3>

View File

@@ -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="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" rel="next" title="A Brief Introduction to the Zettelkasten Method"> <link href="Target-Audience.html#Target-Audience" rel="next" title="Target Audience">
<link href="index.html#Top" rel="prev" title="Top"> <link href="index.html#Top" rel="prev" title="Top">
<style type="text/css"> <style type="text/css">
<!-- <!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Introduction"></a> <a name="Introduction"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Target-Audience.html#Target-Audience" accesskey="n" rel="next">Target Audience</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>
<hr> <hr>
<a name="Introduction-1"></a> <a name="Introduction-1"></a>
@@ -107,7 +107,7 @@ to further introduce features enabled by the Emacs ecosystem.
<hr> <hr>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Target-Audience.html#Target-Audience" accesskey="n" rel="next">Target Audience</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>

View File

@@ -67,7 +67,7 @@ Next: <a href="Encryption.html#Encryption" accesskey="n" rel="next">Encryption</
</div> </div>
<hr> <hr>
<a name="Navigating-Around-1"></a> <a name="Navigating-Around-1"></a>
<h2 class="chapter">8 Navigating Around</h2> <h2 class="chapter">9 Navigating Around</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Index-File.html#Index-File" accesskey="1">Index File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Index-File.html#Index-File" accesskey="1">Index File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Previous: <a href="Org_002djournal.html#Org_002djournal" accesskey="p" rel="prev
</div> </div>
<hr> <hr>
<a name="Note_002dtaking-Add_002dons-1"></a> <a name="Note_002dtaking-Add_002dons-1"></a>
<h4 class="subsection">16.2.5 Note-taking Add-ons</h4> <h4 class="subsection">17.2.5 Note-taking Add-ons</h4>
<p>These are some plugins that make note-taking in Org-mode more enjoyable. <p>These are some plugins that make note-taking in Org-mode more enjoyable.
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Ecosystem.html#Ecosystem" accesskey="n" rel="next">Ecosystem</a>,
</div> </div>
<hr> <hr>
<a name="Note_002dtaking-Workflows-1"></a> <a name="Note_002dtaking-Workflows-1"></a>
<h3 class="section">16.1 Note-taking Workflows</h3> <h3 class="section">17.1 Note-taking Workflows</h3>
<dl compact="compact"> <dl compact="compact">
<dt>Books</dt> <dt>Books</dt>

View File

@@ -67,7 +67,7 @@ Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" acc
</div> </div>
<hr> <hr>
<a name="Org_002djournal-1"></a> <a name="Org_002djournal-1"></a>
<h4 class="subsection">16.2.4 Org-journal</h4> <h4 class="subsection">17.2.4 Org-journal</h4>
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more <p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more
powerful alternative to the simple function <code>org-roam-dailies-today</code>. It powerful alternative to the simple function <code>org-roam-dailies-today</code>. It

View File

@@ -67,7 +67,7 @@ Next: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="n" rel="next">Roam P
</div> </div>
<hr> <hr>
<a name="Org_002droam-Completion-System-1"></a> <a name="Org_002droam-Completion-System-1"></a>
<h2 class="chapter">11 Org-roam Completion System</h2> <h2 class="chapter">12 Org-roam Completion System</h2>
<p>Org-roam allows customization of which minibuffer completion system to use for <p>Org-roam allows customization of which minibuffer completion system to use for
its interactive commands. The default setting uses Emacs&rsquo; standard its interactive commands. The default setting uses Emacs&rsquo; standard

View File

@@ -67,7 +67,7 @@ Previous: <a href="Org_002droam-Links.html#Org_002droam-Links" accesskey="p" rel
</div> </div>
<hr> <hr>
<a name="Org_002droam-Files-1"></a> <a name="Org_002droam-Files-1"></a>
<h3 class="section">7.4 Org-roam Files</h3> <h3 class="section">8.4 Org-roam Files</h3>
<p>Org-roam files are created and prefilled using Org-roam&rsquo;s templating <p>Org-roam files are created and prefilled using Org-roam&rsquo;s templating
system. The templating system is customizable (see <a href="The-Templating-System.html#The-Templating-System">The Templating System</a>). system. The templating system is customizable (see <a href="The-Templating-System.html#The-Templating-System">The Templating System</a>).

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Files.html#Org_002droam-Files" accesskey="n" rel="ne
</div> </div>
<hr> <hr>
<a name="Org_002droam-Links-1"></a> <a name="Org_002droam-Links-1"></a>
<h3 class="section">7.3 Org-roam Links</h3> <h3 class="section">8.3 Org-roam Links</h3>
<p>Org-roam links are regular <code>file:</code> links in Org-mode. By default, links are <p>Org-roam links are regular <code>file:</code> links in Org-mode. By default, links are
inserted with the title as the link description with <code>org-roam-insert</code>. inserted with the title as the link description with <code>org-roam-insert</code>.

View File

@@ -67,7 +67,7 @@ Previous: <a href="Template-Walkthrough.html#Template-Walkthrough" accesskey="p"
</div> </div>
<hr> <hr>
<a name="Org_002droam-Template-Expansion-1"></a> <a name="Org_002droam-Template-Expansion-1"></a>
<h3 class="section">6.2 Org-roam Template Expansion</h3> <h3 class="section">7.2 Org-roam Template Expansion</h3>
<p>Org-roam&rsquo;s template definitions also extend org-capture&rsquo;s template syntax, to <p>Org-roam&rsquo;s template definitions also extend org-capture&rsquo;s template syntax, to
allow prefilling of strings. We have seen a glimpse of this in <a href="Template-Walkthrough.html#Template-Walkthrough">Template allow prefilling of strings. We have seen a glimpse of this in <a href="Template-Walkthrough.html#Template-Walkthrough">Template

View File

@@ -67,7 +67,7 @@ Next: <a href="Appendix.html#Appendix" accesskey="n" rel="next">Appendix</a>, Pr
</div> </div>
<hr> <hr>
<a name="Performance-Optimization-1"></a> <a name="Performance-Optimization-1"></a>
<h2 class="chapter">15 Performance Optimization</h2> <h2 class="chapter">16 Performance Optimization</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Profiling-Key-Operations.html#Profiling-Key-Operations" accesskey="1">Profiling Key Operations</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Profiling-Key-Operations.html#Profiling-Key-Operations" accesskey="1">Profiling Key Operations</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Previous: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-G
</div> </div>
<hr> <hr>
<a name="Post_002dInstallation-Tasks-1"></a> <a name="Post_002dInstallation-Tasks-1"></a>
<h3 class="section">3.4 Post-Installation Tasks</h3> <h3 class="section">4.4 Post-Installation Tasks</h3>
<p>Org-roam uses <code>emacsql-sqlite3</code>, which requires <code>sqlite3</code> to be located on <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 <code>exec-path</code>. Please ensure that <code>sqlite3</code> is installed appropriately on your

View File

@@ -67,7 +67,7 @@ Next: <a href="Garbage-Collection.html#Garbage-Collection" accesskey="n" rel="ne
</div> </div>
<hr> <hr>
<a name="TODO-Profiling-Key-Operations"></a> <a name="TODO-Profiling-Key-Operations"></a>
<h3 class="section">15.1 <strong>TODO</strong> Profiling Key Operations</h3> <h3 class="section">16.1 <strong>TODO</strong> Profiling Key Operations</h3>

View File

@@ -67,7 +67,7 @@ Next: <a href="Daily-Notes.html#Daily-Notes" accesskey="n" rel="next">Daily Note
</div> </div>
<hr> <hr>
<a name="Roam-Protocol-1"></a> <a name="Roam-Protocol-1"></a>
<h2 class="chapter">12 Roam Protocol</h2> <h2 class="chapter">13 Roam Protocol</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -67,7 +67,7 @@ Next: <a href="File-Refs.html#File-Refs" accesskey="n" rel="next">File Refs</a>,
</div> </div>
<hr> <hr>
<a name="Tags-1"></a> <a name="Tags-1"></a>
<h3 class="section">5.2 Tags</h3> <h3 class="section">6.2 Tags</h3>
<p>Tags are used as meta-data for files: they facilitate interactions with notes <p>Tags are used as meta-data for files: they facilitate interactions with notes
where titles are insufficient. For example, tags allow for categorization of where titles are insufficient. For example, tags allow for categorization of

112
manual/Target-Audience.html Normal file
View File

@@ -0,0 +1,112 @@
<!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>Target Audience (Org-roam User Manual)</title>
<meta name="description" content="Target Audience (Org-roam User Manual)">
<meta name="keywords" content="Target Audience (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="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" rel="next" title="A Brief Introduction to the Zettelkasten Method">
<link href="Introduction.html#Introduction" rel="prev" title="Introduction">
<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="Target-Audience"></a>
<div class="header">
<p>
Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Target-Audience-1"></a>
<h2 class="chapter">2 Target Audience</h2>
<p>Org-roam is a tool that will appear unfriendly to anyone unfamiliar with Emacs
and Org-mode, but is also extremely powerful to those willing to put effort in
mastering the intricacies of the tools. Org-roam stands on the shoulders on
giants. Emacs was first created in 1985, and remains a top tier tool for editing
text and designing textual interfaces. The malleability of Emacs allowed the
creation of Org-mode, an all-purpose plain-text system for maintaining TODO
lists, planning projects, and authoring documents. Both of these tools are
incredibly vast and require significant time investment to master.
</p>
<p>Org-roam assumes basic familiarity with these tools. It is not difficult to get
up and running with basic text-editing functionality, but one will only fully
appreciate the power of building Roam functionality into Emacs and Org-mode when
the usage of these tools become more advanced.
</p>
<p>One key advantage to Org-roam is that building on top of Emacs gives it
malleability. This is especially important for note-taking workflows. It is our
belief that note-taking workflows are extremely personal, and there is no one
tool that&rsquo;s perfect for you. Org-mode and Org-roam allows you to discover what
works for you, and build that perfect tool for yourself.
</p>
<p>If you are new to the software, and choose to take this leap of faith, I hope
you find yourself equally entranced as Neal Stephenson was.
</p>
<blockquote>
<p>Emacs outshines all other editing software in approximately the same way that
the noonday sun does the stars. It is not just bigger and brighter; it simply
makes everything else vanish. Neal Stephenson, In the Beginning was the
Command Line (1998)
</p>
</blockquote>
<hr>
<div class="header">
<p>
Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
</body>
</html>

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expans
</div> </div>
<hr> <hr>
<a name="Template-Walkthrough-1"></a> <a name="Template-Walkthrough-1"></a>
<h3 class="section">6.1 Template Walkthrough</h3> <h3 class="section">7.1 Template Walkthrough</h3>
<p>To demonstrate the additions made to org-capture templates. Here, we walkthrough <p>To demonstrate the additions made to org-capture templates. Here, we walkthrough
the default template, reproduced below. the default template, reproduced below.

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Links.html#Org_002droam-Links" accesskey="n" rel="ne
</div> </div>
<hr> <hr>
<a name="The-Org_002droam-Buffer-1"></a> <a name="The-Org_002droam-Buffer-1"></a>
<h3 class="section">7.2 The Org-roam Buffer</h3> <h3 class="section">8.2 The Org-roam Buffer</h3>
<p>The Org-roam buffer displays backlinks for the currently active Org-roam note. <p>The Org-roam buffer displays backlinks for the currently active Org-roam note.
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" acces
</div> </div>
<hr> <hr>
<a name="The-Templating-System-1"></a> <a name="The-Templating-System-1"></a>
<h2 class="chapter">6 The Templating System</h2> <h2 class="chapter">7 The Templating System</h2>
<p>Rather than creating blank files on <code>org-roam-insert</code> and <code>org-roam-find-file</code>, <p>Rather than creating blank files on <code>org-roam-insert</code> and <code>org-roam-find-file</code>,
it may be desirable to prefill the file with templated content. This may it may be desirable to prefill the file with templated content. This may

View File

@@ -67,7 +67,7 @@ Next: <a href="The-roam_002dref-protocol.html#The-roam_002dref-protocol" accessk
</div> </div>
<hr> <hr>
<a name="The-roam_002dfile-protocol-1"></a> <a name="The-roam_002dfile-protocol-1"></a>
<h3 class="section">12.3 The roam-file protocol</h3> <h3 class="section">13.3 The roam-file protocol</h3>
<p>This is a simple protocol that opens the path specified by the <code>file</code> <p>This is a simple protocol that opens the path specified by the <code>file</code>
key (e.g. <code>org-protocol://roam-file?file=/tmp/file.org</code>). This is used key (e.g. <code>org-protocol://roam-file?file=/tmp/file.org</code>). This is used

View File

@@ -67,7 +67,7 @@ Previous: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" a
</div> </div>
<hr> <hr>
<a name="The-roam_002dref-protocol-1"></a> <a name="The-roam_002dref-protocol-1"></a>
<h3 class="section">12.4 The roam-ref protocol</h3> <h3 class="section">13.4 The roam-ref protocol</h3>
<p>This protocol finds or creates a new note with a given <code>roam_key</code> (see <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">Anatomy of an Org-roam File</a>): <p>This protocol finds or creates a new note with a given <code>roam_key</code> (see <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">Anatomy of an Org-roam File</a>):
</p> </p>

View File

@@ -67,7 +67,7 @@ Next: <a href="Tags.html#Tags" accesskey="n" rel="next">Tags</a>, Up: <a href="A
</div> </div>
<hr> <hr>
<a name="Titles-1"></a> <a name="Titles-1"></a>
<h3 class="section">5.1 Titles</h3> <h3 class="section">6.1 Titles</h3>
<p>To easily find a note, a title needs to be prescribed to a note. A note can have <p>To easily find a note, a title needs to be prescribed to a note. A note can have
many titles: this allows a note to be referred to by different names, which is many titles: this allows a note to be referred to by different names, which is

View File

@@ -67,7 +67,7 @@ Next: <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-searc
</div> </div>
<hr> <hr>
<a name="Versioning-Notes-1"></a> <a name="Versioning-Notes-1"></a>
<h4 class="subsection">16.2.2 Versioning Notes</h4> <h4 class="subsection">17.2.2 Versioning Notes</h4>
<p>Since Org-roam notes are just plain text, it is trivial to track changes in your <p>Since Org-roam notes are just plain text, it is trivial to track changes in your
notes database using version control systems such as <a href="https://git-scm.com/">Git</a>. Simply initialize notes database using version control systems such as <a href="https://git-scm.com/">Git</a>. Simply initialize

View File

@@ -67,7 +67,7 @@ Next: <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey
</div> </div>
<hr> <hr>
<a name="g_t_005f-_003aignore_003a"></a> <a name="g_t_005f-_003aignore_003a"></a>
<h3 class="section">12.1 _ :ignore:</h3> <h3 class="section">13.1 _ :ignore:</h3>
<p>Org-roam extending <code>org-protocol</code> with 2 protocols: the <code>roam-file</code> <p>Org-roam extending <code>org-protocol</code> with 2 protocols: the <code>roam-file</code>
and <code>roam-ref</code> protocol. and <code>roam-ref</code> protocol.

View File

@@ -71,68 +71,69 @@ ul.no-bullet {list-style: none}
<ul class="no-bullet"> <ul class="no-bullet">
<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-A-Brief-Introduction-to-the-Zettelkasten-Method-1" href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method">2 A Brief Introduction to the Zettelkasten Method</a></li> <li><a name="toc-Target-Audience-1" href="Target-Audience.html#Target-Audience">2 Target Audience</a></li>
<li><a name="toc-Installation-1" href="Installation.html#Installation">3 Installation</a> <li><a name="toc-A-Brief-Introduction-to-the-Zettelkasten-Method-1" href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method">3 A Brief Introduction to the Zettelkasten Method</a></li>
<li><a name="toc-Installation-1" href="Installation.html#Installation">4 Installation</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">3.1 Installing from MELPA</a></li> <li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">4.1 Installing from MELPA</a></li>
<li><a name="toc-Installing-from-Apt-1" href="Installing-from-Apt.html#Installing-from-Apt">3.2 Installing from Apt</a></li> <li><a name="toc-Installing-from-Apt-1" href="Installing-from-Apt.html#Installing-from-Apt">4.2 Installing from Apt</a></li>
<li><a name="toc-TODO-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">3.3 <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">4.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">3.4 Post-Installation Tasks</a></li> <li><a name="toc-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">4.4 Post-Installation Tasks</a></li>
</ul></li> </ul></li>
<li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">4 Getting Started</a></li> <li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">5 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">5 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">6 Anatomy of an Org-roam File</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Titles-1" href="Titles.html#Titles">5.1 Titles</a></li> <li><a name="toc-Titles-1" href="Titles.html#Titles">6.1 Titles</a></li>
<li><a name="toc-Tags-1" href="Tags.html#Tags">5.2 Tags</a></li> <li><a name="toc-Tags-1" href="Tags.html#Tags">6.2 Tags</a></li>
<li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">5.3 File Refs</a></li> <li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">6.3 File Refs</a></li>
</ul></li> </ul></li>
<li><a name="toc-The-Templating-System-1" href="The-Templating-System.html#The-Templating-System">6 The Templating System</a> <li><a name="toc-The-Templating-System-1" href="The-Templating-System.html#The-Templating-System">7 The Templating System</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Template-Walkthrough-1" href="Template-Walkthrough.html#Template-Walkthrough">6.1 Template Walkthrough</a></li> <li><a name="toc-Template-Walkthrough-1" href="Template-Walkthrough.html#Template-Walkthrough">7.1 Template Walkthrough</a></li>
<li><a name="toc-Org_002droam-Template-Expansion-1" href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expansion">6.2 Org-roam Template Expansion</a></li> <li><a name="toc-Org_002droam-Template-Expansion-1" href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expansion">7.2 Org-roam Template Expansion</a></li>
</ul></li> </ul></li>
<li><a name="toc-Concepts-and-Configuration-1" href="Concepts-and-Configuration.html#Concepts-and-Configuration">7 Concepts and Configuration</a> <li><a name="toc-Concepts-and-Configuration-1" href="Concepts-and-Configuration.html#Concepts-and-Configuration">8 Concepts and Configuration</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Directories-and-Files-1" href="Directories-and-Files.html#Directories-and-Files">7.1 Directories and Files</a></li> <li><a name="toc-Directories-and-Files-1" href="Directories-and-Files.html#Directories-and-Files">8.1 Directories and Files</a></li>
<li><a name="toc-The-Org_002droam-Buffer-1" href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">7.2 The Org-roam Buffer</a></li> <li><a name="toc-The-Org_002droam-Buffer-1" href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">8.2 The Org-roam Buffer</a></li>
<li><a name="toc-Org_002droam-Links-1" href="Org_002droam-Links.html#Org_002droam-Links">7.3 Org-roam Links</a></li> <li><a name="toc-Org_002droam-Links-1" href="Org_002droam-Links.html#Org_002droam-Links">8.3 Org-roam Links</a></li>
<li><a name="toc-Org_002droam-Files-1" href="Org_002droam-Files.html#Org_002droam-Files">7.4 Org-roam Files</a></li> <li><a name="toc-Org_002droam-Files-1" href="Org_002droam-Files.html#Org_002droam-Files">8.4 Org-roam Files</a></li>
</ul></li> </ul></li>
<li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">8 Navigating Around</a> <li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">9 Navigating Around</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Index-File-1" href="Index-File.html#Index-File">8.1 Index File</a></li> <li><a name="toc-Index-File-1" href="Index-File.html#Index-File">9.1 Index File</a></li>
</ul></li> </ul></li>
<li><a name="toc-Encryption-1" href="Encryption.html#Encryption">9 Encryption</a></li> <li><a name="toc-Encryption-1" href="Encryption.html#Encryption">10 Encryption</a></li>
<li><a name="toc-Graphing-1" href="Graphing.html#Graphing">10 Graphing</a> <li><a name="toc-Graphing-1" href="Graphing.html#Graphing">11 Graphing</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Graph-Options-1" href="Graph-Options.html#Graph-Options">10.1 Graph Options</a></li> <li><a name="toc-Graph-Options-1" href="Graph-Options.html#Graph-Options">11.1 Graph Options</a></li>
<li><a name="toc-Excluding-Nodes-and-Edges-1" href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges">10.2 Excluding Nodes and Edges</a></li> <li><a name="toc-Excluding-Nodes-and-Edges-1" href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges">11.2 Excluding Nodes and Edges</a></li>
</ul></li> </ul></li>
<li><a name="toc-Org_002droam-Completion-System-1" href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">11 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">12 Org-roam Completion System</a></li>
<li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">12 Roam Protocol</a> <li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">13 Roam Protocol</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">12.1 _ :ignore:</a></li> <li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">13.1 _ :ignore:</a></li>
<li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">12.2 Installation</a></li> <li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">13.2 Installation</a></li>
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">12.3 The roam-file protocol</a></li> <li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">13.3 The roam-file protocol</a></li>
<li><a name="toc-The-roam_002dref-protocol-1" href="The-roam_002dref-protocol.html#The-roam_002dref-protocol">12.4 The roam-ref protocol</a></li> <li><a name="toc-The-roam_002dref-protocol-1" href="The-roam_002dref-protocol.html#The-roam_002dref-protocol">13.4 The roam-ref protocol</a></li>
</ul></li> </ul></li>
<li><a name="toc-TODO-Daily-Notes" href="Daily-Notes.html#Daily-Notes">13 <strong>TODO</strong> Daily Notes</a></li> <li><a name="toc-TODO-Daily-Notes" href="Daily-Notes.html#Daily-Notes">14 <strong>TODO</strong> Daily Notes</a></li>
<li><a name="toc-Diagnosing-and-Repairing-Files-1" href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">14 Diagnosing and Repairing Files</a></li> <li><a name="toc-Diagnosing-and-Repairing-Files-1" href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">15 Diagnosing and Repairing Files</a></li>
<li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">15 Performance Optimization</a> <li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">16 Performance Optimization</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-TODO-Profiling-Key-Operations" href="Profiling-Key-Operations.html#Profiling-Key-Operations">15.1 <strong>TODO</strong> Profiling Key Operations</a></li> <li><a name="toc-TODO-Profiling-Key-Operations" href="Profiling-Key-Operations.html#Profiling-Key-Operations">16.1 <strong>TODO</strong> Profiling Key Operations</a></li>
<li><a name="toc-Garbage-Collection-1" href="Garbage-Collection.html#Garbage-Collection">15.2 Garbage Collection</a></li> <li><a name="toc-Garbage-Collection-1" href="Garbage-Collection.html#Garbage-Collection">16.2 Garbage Collection</a></li>
</ul></li> </ul></li>
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">16 Appendix</a> <li><a name="toc-Appendix-1" href="Appendix.html#Appendix">17 Appendix</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">16.1 Note-taking Workflows</a></li> <li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">17.1 Note-taking Workflows</a></li>
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">16.2 Ecosystem</a> <li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">17.2 Ecosystem</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Browsing-History-with-winner_002dmode-1" href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode">16.2.1 Browsing History with winner-mode</a></li> <li><a name="toc-Browsing-History-with-winner_002dmode-1" href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode">17.2.1 Browsing History with winner-mode</a></li>
<li><a name="toc-Versioning-Notes-1" href="Versioning-Notes.html#Versioning-Notes">16.2.2 Versioning Notes</a></li> <li><a name="toc-Versioning-Notes-1" href="Versioning-Notes.html#Versioning-Notes">17.2.2 Versioning Notes</a></li>
<li><a name="toc-Full_002dtext-search-interface-with-Deft-1" href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft">16.2.3 Full-text search interface with Deft</a></li> <li><a name="toc-Full_002dtext-search-interface-with-Deft-1" href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft">17.2.3 Full-text search interface with Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">16.2.4 Org-journal</a></li> <li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">17.2.4 Org-journal</a></li>
<li><a name="toc-Note_002dtaking-Add_002dons-1" href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">16.2.5 Note-taking Add-ons</a> <li><a name="toc-Note_002dtaking-Add_002dons-1" href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">17.2.5 Note-taking Add-ons</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Org_002ddownload-1" href="Org_002ddownload.html#Org_002ddownload">Org-download</a></li> <li><a name="toc-Org_002ddownload-1" href="Org_002ddownload.html#Org_002ddownload">Org-download</a></li>
<li><a name="toc-mathpix_002eel" href="mathpixel.html#mathpixel">mathpix.el</a></li> <li><a name="toc-mathpix_002eel" href="mathpixel.html#mathpixel">mathpix.el</a></li>
@@ -142,10 +143,10 @@ ul.no-bullet {list-style: none}
</ul></li> </ul></li>
</ul></li> </ul></li>
</ul></li> </ul></li>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">17 FAQ</a> <li><a name="toc-FAQ-1" href="FAQ.html#FAQ">18 FAQ</a>
<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">17.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">18.1 How do I have more than one Org-roam directory?</a></li>
<li><a name="toc-How-do-I-migrate-from-Roam-Research_003f-1" href="How-do-I-migrate-from-Roam-Research_003f.html#How-do-I-migrate-from-Roam-Research_003f">17.2 How do I migrate from Roam Research?</a></li> <li><a name="toc-How-do-I-migrate-from-Roam-Research_003f-1" href="How-do-I-migrate-from-Roam-Research_003f.html#How-do-I-migrate-from-Roam-Research_003f">18.2 How do I migrate from Roam Research?</a></li>
</ul></li> </ul></li>
</ul> </ul>
</div> </div>
@@ -180,21 +181,23 @@ General Public License for more details.
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="2">A Brief Introduction to the Zettelkasten Method</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Target-Audience.html#Target-Audience" accesskey="2">Target Audience</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installation.html#Installation" accesskey="3">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="3">A Brief Introduction to the Zettelkasten Method</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Getting-Started.html#Getting-Started" accesskey="4">Getting Started</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installation.html#Installation" accesskey="4">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="5">Anatomy of an Org-roam File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Getting-Started.html#Getting-Started" accesskey="5">Getting Started</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-Templating-System.html#The-Templating-System" accesskey="6">The Templating System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="6">Anatomy of an Org-roam File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="7">Concepts and Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="The-Templating-System.html#The-Templating-System" accesskey="7">The Templating System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Navigating-Around.html#Navigating-Around" accesskey="8">Navigating Around</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="8">Concepts and Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Encryption.html#Encryption" accesskey="9">Encryption</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Navigating-Around.html#Navigating-Around" accesskey="9">Navigating Around</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Encryption.html#Encryption">Encryption</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Graphing.html#Graphing">Graphing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Graphing.html#Graphing">Graphing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>

View File

@@ -56,6 +56,38 @@ Org-roam provides several benefits over other tooling:
- 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.
* Target Audience
Org-roam is a tool that will appear unfriendly to anyone unfamiliar with Emacs
and Org-mode, but is also extremely powerful to those willing to put effort in
mastering the intricacies of the tools. Org-roam stands on the shoulders on
giants. Emacs was first created in 1985, and remains a top tier tool for editing
text and designing textual interfaces. The malleability of Emacs allowed the
creation of Org-mode, an all-purpose plain-text system for maintaining TODO
lists, planning projects, and authoring documents. Both of these tools are
incredibly vast and require significant time investment to master.
Org-roam assumes basic familiarity with these tools. It is not difficult to get
up and running with basic text-editing functionality, but one will only fully
appreciate the power of building Roam functionality into Emacs and Org-mode when
the usage of these tools become more advanced.
One key advantage to Org-roam is that building on top of Emacs gives it
malleability. This is especially important for note-taking workflows. It is our
belief that note-taking workflows are extremely personal, and there is no one
tool that's perfect for you. Org-mode and Org-roam allows you to discover what
works for you, and build that perfect tool for yourself.
If you are new to the software, and choose to take this leap of faith, I hope
you find yourself equally entranced as Neal Stephenson was.
#+BEGIN_QUOTE
Emacs outshines all other editing software in approximately the same way that
the noonday sun does the stars. It is not just bigger and brighter; it simply
makes everything else vanish. Neal Stephenson, In the Beginning was the
Command Line (1998)
#+END_QUOTE
* A Brief Introduction to the Zettelkasten Method * A Brief Introduction to the Zettelkasten Method
Org-roam provides utilities for maintaining a digital slip-box. This section Org-roam provides utilities for maintaining a digital slip-box. This section

View File

@@ -65,6 +65,7 @@ General Public License for more details.
@menu @menu
* Introduction:: * Introduction::
* Target Audience::
* A Brief Introduction to the Zettelkasten Method:: * A Brief Introduction to the Zettelkasten Method::
* Installation:: * Installation::
* Getting Started:: * Getting Started::
@@ -186,6 +187,40 @@ Over the years, Emacs and Org-mode has developed into a mature system for plain-
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. 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.
@end table @end table
@node Target Audience
@chapter Target Audience
Org-roam is a tool that will appear unfriendly to anyone unfamiliar with Emacs
and Org-mode, but is also extremely powerful to those willing to put effort in
mastering the intricacies of the tools. Org-roam stands on the shoulders on
giants. Emacs was first created in 1985, and remains a top tier tool for editing
text and designing textual interfaces. The malleability of Emacs allowed the
creation of Org-mode, an all-purpose plain-text system for maintaining TODO
lists, planning projects, and authoring documents. Both of these tools are
incredibly vast and require significant time investment to master.
Org-roam assumes basic familiarity with these tools. It is not difficult to get
up and running with basic text-editing functionality, but one will only fully
appreciate the power of building Roam functionality into Emacs and Org-mode when
the usage of these tools become more advanced.
One key advantage to Org-roam is that building on top of Emacs gives it
malleability. This is especially important for note-taking workflows. It is our
belief that note-taking workflows are extremely personal, and there is no one
tool that's perfect for you. Org-mode and Org-roam allows you to discover what
works for you, and build that perfect tool for yourself.
If you are new to the software, and choose to take this leap of faith, I hope
you find yourself equally entranced as Neal Stephenson was.
@quotation
Emacs outshines all other editing software in approximately the same way that
the noonday sun does the stars. It is not just bigger and brighter; it simply
makes everything else vanish. Neal Stephenson, In the Beginning was the
Command Line (1998)
@end quotation
@node A Brief Introduction to the Zettelkasten Method @node A Brief Introduction to the Zettelkasten Method
@chapter A Brief Introduction to the Zettelkasten Method @chapter A Brief Introduction to the Zettelkasten Method