Deploying to gh-pages from @ 2f4034cebc 🚀

This commit is contained in:
jethrokuan
2020-09-27 07:22:27 +00:00
parent 4e63382bb7
commit 3d7d77e0c2
33 changed files with 337 additions and 218 deletions

View File

@@ -67,7 +67,7 @@ Next: <a href="FAQ.html#FAQ" accesskey="n" rel="next">FAQ</a>, Previous: <a href
</div>
<hr>
<a name="Appendix-1"></a>
<h2 class="chapter">18 Appendix</h2>
<h2 class="chapter">19 Appendix</h2>
<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">

View File

@@ -67,7 +67,7 @@ Next: <a href="Versioning-Notes.html#Versioning-Notes" accesskey="n" rel="next">
</div>
<hr>
<a name="Browsing-History-with-winner_002dmode-1"></a>
<h4 class="subsection">18.2.1 Browsing History with winner-mode</h4>
<h4 class="subsection">19.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>

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#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Performance-Optimization.html#Performance-Optimization" rel="next" title="Performance Optimization">
<link href="Finding-Unlinked-References.html#Finding-Unlinked-References" rel="next" title="Finding Unlinked References">
<link href="Daily-Notes.html#Daily-Notes" rel="prev" title="Daily Notes">
<style type="text/css">
<!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Diagnosing-and-Repairing-Files"></a>
<div class="header">
<p>
Next: <a href="Performance-Optimization.html#Performance-Optimization" accesskey="n" rel="next">Performance Optimization</a>, Previous: <a href="Daily-Notes.html#Daily-Notes" accesskey="p" rel="prev">Daily Notes</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="Finding-Unlinked-References.html#Finding-Unlinked-References" accesskey="n" rel="next">Finding Unlinked References</a>, Previous: <a href="Daily-Notes.html#Daily-Notes" accesskey="p" rel="prev">Daily Notes</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="Diagnosing-and-Repairing-Files-1"></a>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" acc
</div>
<hr>
<a name="Ecosystem-1"></a>
<h3 class="section">18.2 Ecosystem</h3>
<h3 class="section">19.2 Ecosystem</h3>
<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">

View File

@@ -67,7 +67,7 @@ Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</a>
</div>
<hr>
<a name="FAQ-1"></a>
<h2 class="chapter">19 FAQ</h2>
<h2 class="chapter">20 FAQ</h2>
<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">

View File

@@ -0,0 +1,87 @@
<!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>Finding Unlinked References (Org-roam User Manual)</title>
<meta name="description" content="Finding Unlinked References (Org-roam User Manual)">
<meta name="keywords" content="Finding Unlinked References (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="Performance-Optimization.html#Performance-Optimization" rel="next" title="Performance Optimization">
<link href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" rel="prev" title="Diagnosing and Repairing Files">
<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="Finding-Unlinked-References"></a>
<div class="header">
<p>
Next: <a href="Performance-Optimization.html#Performance-Optimization" accesskey="n" rel="next">Performance Optimization</a>, Previous: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" accesskey="p" rel="prev">Diagnosing and Repairing Files</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="Finding-Unlinked-References-1"></a>
<h2 class="chapter">17 Finding Unlinked References</h2>
<p>Unlinked references are occurrences of strings of text that exactly match the
title or alias of an existing note in the Org-roam database. Org-roam provides
facilities for discovering these unlinked references, so one may decide whether
to convert them into links.
</p>
<p>To use this feature, simply call <code>M-x org-roam-unlinked-references</code> from within
an Org-roam note. Org-roam uses <a href="https://github.com/BurntSushi/ripgrep">ripgrep</a>, specifically a clever PCRE regex to
find occurrences of the title or aliases of the currently open note in all
Org-roam files. This thus requires a version of ripgrep that is compiled with
PCRE support.
</p>
</body>
</html>

View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002djournal.html#Org_002djournal" accesskey="n" rel="next">Or
</div>
<hr>
<a name="Full_002dtext-search-interface-with-Deft-1"></a>
<h4 class="subsection">18.2.3 Full-text search interface with Deft</h4>
<h4 class="subsection">19.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>

View File

@@ -67,7 +67,7 @@ Previous: <a href="Profiling-Key-Operations.html#Profiling-Key-Operations" acces
</div>
<hr>
<a name="Garbage-Collection-1"></a>
<h3 class="section">17.2 Garbage Collection</h3>
<h3 class="section">18.2 Garbage Collection</h3>
<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>).

View File

@@ -67,7 +67,7 @@ Next: <a href="How-do-I-migrate-from-Roam-Research_003f.html#How-do-I-migrate-fr
</div>
<hr>
<a name="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></a>
<h3 class="section">19.1 How do I have more than one Org-roam directory?</h3>
<h3 class="section">20.1 How do I have more than one Org-roam directory?</h3>
<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

View File

@@ -66,7 +66,7 @@ Previous: <a href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#
</div>
<hr>
<a name="How-do-I-migrate-from-Roam-Research_003f-1"></a>
<h3 class="section">19.2 How do I migrate from Roam Research?</h3>
<h3 class="section">20.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>

View File

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

View File

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

View File

@@ -67,7 +67,7 @@ Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" acc
</div>
<hr>
<a name="Org_002djournal-1"></a>
<h4 class="subsection">18.2.4 Org-journal</h4>
<h4 class="subsection">19.2.4 Org-journal</h4>
<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

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#Top" rel="up" title="Top">
<link href="Profiling-Key-Operations.html#Profiling-Key-Operations" rel="next" title="Profiling Key Operations">
<link href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" rel="prev" title="Diagnosing and Repairing Files">
<link href="Finding-Unlinked-References.html#Finding-Unlinked-References" rel="prev" title="Finding Unlinked References">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
<a name="Performance-Optimization"></a>
<div class="header">
<p>
Next: <a href="Appendix.html#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" accesskey="p" rel="prev">Diagnosing and Repairing Files</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="Appendix.html#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a href="Finding-Unlinked-References.html#Finding-Unlinked-References" accesskey="p" rel="prev">Finding Unlinked References</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="Performance-Optimization-1"></a>
<h2 class="chapter">17 Performance Optimization</h2>
<h2 class="chapter">18 Performance Optimization</h2>
<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">

View File

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

View File

@@ -67,7 +67,7 @@ Next: <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-searc
</div>
<hr>
<a name="Versioning-Notes-1"></a>
<h4 class="subsection">18.2.2 Versioning Notes</h4>
<h4 class="subsection">19.2.2 Versioning Notes</h4>
<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

View File

@@ -119,21 +119,22 @@ ul.no-bullet {list-style: none}
</ul></li>
<li><a name="toc-TODO-Daily-Notes" href="Daily-Notes.html#Daily-Notes">15 <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">16 Diagnosing and Repairing Files</a></li>
<li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">17 Performance Optimization</a>
<li><a name="toc-Finding-Unlinked-References-1" href="Finding-Unlinked-References.html#Finding-Unlinked-References">17 Finding Unlinked References</a></li>
<li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">18 Performance Optimization</a>
<ul class="no-bullet">
<li><a name="toc-TODO-Profiling-Key-Operations" href="Profiling-Key-Operations.html#Profiling-Key-Operations">17.1 <strong>TODO</strong> Profiling Key Operations</a></li>
<li><a name="toc-Garbage-Collection-1" href="Garbage-Collection.html#Garbage-Collection">17.2 Garbage Collection</a></li>
<li><a name="toc-TODO-Profiling-Key-Operations" href="Profiling-Key-Operations.html#Profiling-Key-Operations">18.1 <strong>TODO</strong> Profiling Key Operations</a></li>
<li><a name="toc-Garbage-Collection-1" href="Garbage-Collection.html#Garbage-Collection">18.2 Garbage Collection</a></li>
</ul></li>
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">18 Appendix</a>
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">19 Appendix</a>
<ul class="no-bullet">
<li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">18.1 Note-taking Workflows</a></li>
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">18.2 Ecosystem</a>
<li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">19.1 Note-taking Workflows</a></li>
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">19.2 Ecosystem</a>
<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">18.2.1 Browsing History with winner-mode</a></li>
<li><a name="toc-Versioning-Notes-1" href="Versioning-Notes.html#Versioning-Notes">18.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">18.2.3 Full-text search interface with Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">18.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">18.2.5 Note-taking Add-ons</a>
<li><a name="toc-Browsing-History-with-winner_002dmode-1" href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode">19.2.1 Browsing History with winner-mode</a></li>
<li><a name="toc-Versioning-Notes-1" href="Versioning-Notes.html#Versioning-Notes">19.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">19.2.3 Full-text search interface with Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">19.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">19.2.5 Note-taking Add-ons</a>
<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-mathpix_002eel" href="mathpixel.html#mathpixel">mathpix.el</a></li>
@@ -143,10 +144,10 @@ ul.no-bullet {list-style: none}
</ul></li>
</ul></li>
</ul></li>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">19 FAQ</a>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">20 FAQ</a>
<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">19.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">19.2 How do I migrate from Roam Research?</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">20.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">20.2 How do I migrate from Roam Research?</a></li>
</ul></li>
</ul>
</div>
@@ -211,6 +212,8 @@ General Public License for more details.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">Diagnosing and Repairing Files</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Finding-Unlinked-References.html#Finding-Unlinked-References">Finding Unlinked References</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Performance-Optimization.html#Performance-Optimization">Performance Optimization</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Appendix.html#Appendix">Appendix</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

View File

@@ -1023,6 +1023,20 @@ checker, to perform autofixes for the errors. For each error detected,
~org-roam-doctor~ will move the point to the current error, and pop-up a help
window displaying the error message, as well as the list of actions that can be
taken provided in ~:actions~.
* Finding Unlinked References
Unlinked references are occurrences of strings of text that exactly match the
title or alias of an existing note in the Org-roam database. Org-roam provides
facilities for discovering these unlinked references, so one may decide whether
to convert them into links.
To use this feature, simply call ~M-x org-roam-unlinked-references~ from within
an Org-roam note. Org-roam uses [[https://github.com/BurntSushi/ripgrep][ripgrep]], specifically a clever PCRE regex to
find occurrences of the title or aliases of the currently open note in all
Org-roam files. This thus requires a version of ripgrep that is compiled with
PCRE support.
* Performance Optimization
** TODO Profiling Key Operations
** Garbage Collection

View File

@@ -80,6 +80,7 @@ General Public License for more details.
* Roam Protocol::
* Daily Notes::
* Diagnosing and Repairing Files::
* Finding Unlinked References::
* Performance Optimization::
* Appendix::
* FAQ::
@@ -1355,6 +1356,20 @@ checker, to perform autofixes for the errors. For each error detected,
window displaying the error message, as well as the list of actions that can be
taken provided in @code{:actions}.
@node Finding Unlinked References
@chapter Finding Unlinked References
Unlinked references are occurrences of strings of text that exactly match the
title or alias of an existing note in the Org-roam database. Org-roam provides
facilities for discovering these unlinked references, so one may decide whether
to convert them into links.
To use this feature, simply call @code{M-x org-roam-unlinked-references} from within
an Org-roam note. Org-roam uses @uref{https://github.com/BurntSushi/ripgrep, ripgrep}, specifically a clever PCRE regex to
find occurrences of the title or aliases of the currently open note in all
Org-roam files. This thus requires a version of ripgrep that is compiled with
PCRE support.
@node Performance Optimization
@chapter Performance Optimization