awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-17 13:33:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ e33c3bcb3f 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-06-28 07:16:48 +00:00
parent 578e93a8a1
commit ddb7708f49
16 changed files with 332 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
manual/Appendix.html
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="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" rel="next" title="Note-taking Workflows">
<link href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" rel="prev" title="Diagnosing and Repairing Files">
<link href="Garbage-Collection.html#Garbage-Collection" rel="prev" title="Garbage Collection">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
<a name="Appendix"></a>
<div class="header">
<p>
Next: <a href="FAQ.html#FAQ" accesskey="n" rel="next">FAQ</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="FAQ.html#FAQ" accesskey="n" rel="next">FAQ</a>, Previous: <a href="Performance-Optimization.html#Performance-Optimization" accesskey="p" rel="prev">Performance Optimization</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="Appendix-1"></a>
<h2 class="chapter">15 Appendix</h2>
<h2 class="chapter">16 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">

2
manual/Deft.html
View File

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

4
manual/Diagnosing-and-Repairing-Files.html
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="Appendix.html#Appendix" rel="next" title="Appendix">
<link href="Performance-Optimization.html#Performance-Optimization" rel="next" title="Performance Optimization">
<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="Appendix.html#Appendix" accesskey="n" rel="next">Appendix</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="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>
</div>
<hr>
<a name="Diagnosing-and-Repairing-Files-1"></a>

2
manual/Ecosystem.html
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">15.2 Ecosystem</h3>
<h3 class="section">16.2 Ecosystem</h3>
<p>A number of packages work well combined with Org-Roam:
</p>

2
manual/FAQ.html
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">16 FAQ</h2>
<h2 class="chapter">17 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">

88
manual/Garbage-Collection.html Normal file
View File

@@ -0,0 +1,88 @@
<!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>Garbage Collection (Org-roam User Manual)</title>
<meta name="description" content="Garbage Collection (Org-roam User Manual)">
<meta name="keywords" content="Garbage Collection (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="Performance-Optimization.html#Performance-Optimization" rel="up" title="Performance Optimization">
<link href="Appendix.html#Appendix" rel="next" title="Appendix">
<link href="Profiling-Key-Operations.html#Profiling-Key-Operations" rel="prev" title="Profiling Key Operations">
<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="Garbage-Collection"></a>
<div class="header">
<p>
Previous: <a href="Profiling-Key-Operations.html#Profiling-Key-Operations" accesskey="p" rel="prev">Profiling Key Operations</a>, Up: <a href="Performance-Optimization.html#Performance-Optimization" accesskey="u" rel="up">Performance Optimization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Garbage-Collection-1"></a>
<h3 class="section">15.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>).
</p>
<p>Org-roam provides the option <code>org-roam-db-gc-threshold</code> to temporarily change
the threshold value for GC to be triggered during these memory-intensive
operations. To reduce the number of garbage collection processes, one may set
<code>org-roam-db-gc-threshold</code> to a high value (such as <code>most-positive-fixnum</code>):
</p>
<div class="lisp">
<pre class="lisp">(setq org-roam-db-gc-threshold most-positive-fixnum)
</pre></div>
</body>
</html>

2
manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html
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">16.1 How do I have more than one Org-roam directory?</h3>
<h3 class="section">17.1 How do I have more than one Org-roam directory?</h3>
<p>Emacs supports directory-local variables, allowing the value of
&lsquo;<samp>org-roam-directory</samp>&rsquo; to be different in different directories. It does this by

2
manual/How-do-I-migrate-from-Roam-Research_003f.html
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">16.2 How do I migrate from Roam Research?</h3>
<h3 class="section">17.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>

2
manual/Note_002dtaking-Add_002dons.html
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">15.2.3 Note-taking Add-ons</h4>
<h4 class="subsection">16.2.3 Note-taking Add-ons</h4>
<p>These are some plugins that make note-taking in Org-mode more enjoyable.
</p>

2
manual/Note_002dtaking-Workflows.html
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">15.1 Note-taking Workflows</h3>
<h3 class="section">16.1 Note-taking Workflows</h3>
<dl compact="compact">
<dt>Books</dt>

2
manual/Org_002djournal.html
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">15.2.2 Org-journal</h4>
<h4 class="subsection">16.2.2 Org-journal</h4>
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more
powerful alternative to the simple function &lsquo;<samp>org-roam-dailies-today</samp>&rsquo;. It

83
manual/Performance-Optimization.html Normal file
View File

@@ -0,0 +1,83 @@
<!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>Performance Optimization (Org-roam User Manual)</title>
<meta name="description" content="Performance Optimization (Org-roam User Manual)">
<meta name="keywords" content="Performance Optimization (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="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">
<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="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>
</div>
<hr>
<a name="Performance-Optimization-1"></a>
<h2 class="chapter">15 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">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Garbage-Collection.html#Garbage-Collection" accesskey="2">Garbage Collection</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>
</body>
</html>

76
manual/Profiling-Key-Operations.html Normal file
View File

@@ -0,0 +1,76 @@
<!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>Profiling Key Operations (Org-roam User Manual)</title>
<meta name="description" content="Profiling Key Operations (Org-roam User Manual)">
<meta name="keywords" content="Profiling Key Operations (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="Performance-Optimization.html#Performance-Optimization" rel="up" title="Performance Optimization">
<link href="Garbage-Collection.html#Garbage-Collection" rel="next" title="Garbage Collection">
<link href="Performance-Optimization.html#Performance-Optimization" rel="prev" title="Performance Optimization">
<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="Profiling-Key-Operations"></a>
<div class="header">
<p>
Next: <a href="Garbage-Collection.html#Garbage-Collection" accesskey="n" rel="next">Garbage Collection</a>, Up: <a href="Performance-Optimization.html#Performance-Optimization" accesskey="u" rel="up">Performance Optimization</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="TODO-Profiling-Key-Operations"></a>
<h3 class="section">15.1 <strong>TODO</strong> Profiling Key Operations</h3>
</body>
</html>

33
manual/index.html
View File

@@ -117,14 +117,19 @@ ul.no-bullet {list-style: none}
</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-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-Appendix-1" href="Appendix.html#Appendix">15 Appendix</a>
<li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">15 Performance Optimization</a>
<ul class="no-bullet">
<li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">15.1 Note-taking Workflows</a></li>
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">15.2 Ecosystem</a>
<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-Garbage-Collection-1" href="Garbage-Collection.html#Garbage-Collection">15.2 Garbage Collection</a></li>
</ul></li>
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">16 Appendix</a>
<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-Ecosystem-1" href="Ecosystem.html#Ecosystem">16.2 Ecosystem</a>
<ul class="no-bullet">
<li><a name="toc-Deft-1" href="Deft.html#Deft">15.2.1 Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">15.2.2 Org-journal</a></li>
<li><a name="toc-Note_002dtaking-Add_002dons-1" href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">15.2.3 Note-taking Add-ons</a>
<li><a name="toc-Deft-1" href="Deft.html#Deft">16.2.1 Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">16.2.2 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.3 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>
@@ -134,10 +139,10 @@ ul.no-bullet {list-style: none}
</ul></li>
</ul></li>
</ul></li>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">16 FAQ</a>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">17 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">16.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">16.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">17.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>
</ul></li>
</ul>
</div>
@@ -198,6 +203,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="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">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="FAQ.html#FAQ">FAQ</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -272,6 +279,14 @@ Roam Protocol
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Performance Optimization
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Profiling-Key-Operations.html#Profiling-Key-Operations">Profiling Key Operations</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Garbage-Collection.html#Garbage-Collection">Garbage Collection</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Appendix
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">Note-taking Workflows</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

16
org-roam.org
View File

@@ -831,6 +831,22 @@ 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=.
* Performance Optimization
** TODO Profiling Key Operations
** Garbage Collection
During the cache-build process, Org-roam generates a lot of in-memory
data-structures (such as the Org file's AST), which are discarded after use. These structures are garbage collected at regular intervals (see [[info:elisp#Garbage Collection][info:elisp#Garbage Collection]]).
Org-roam provides the option ~org-roam-db-gc-threshold~ to temporarily change
the threshold value for GC to be triggered during these memory-intensive
operations. To reduce the number of garbage collection processes, one may set
~org-roam-db-gc-threshold~ to a high value (such as ~most-positive-fixnum~):
#+BEGIN_SRC emacs-lisp
(setq org-roam-db-gc-threshold most-positive-fixnum)
#+END_SRC
* _ Copying
:PROPERTIES:
:COPYING: t

32
org-roam.texi
View File

@@ -78,6 +78,7 @@ General Public License for more details.
* Roam Protocol::
* Daily Notes::
* Diagnosing and Repairing Files::
* Performance Optimization::
* Appendix::
* FAQ::
@@ -124,6 +125,11 @@ Roam Protocol
* The @samp{roam-file} protocol::
* The @samp{roam-ref} Protocol::
Performance Optimization
* Profiling Key Operations::
* Garbage Collection::
Appendix
* Note-taking Workflows::
@@ -1128,6 +1134,32 @@ 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 @samp{:actions}.
@node Performance Optimization
@chapter Performance Optimization
@menu
* Profiling Key Operations::
* Garbage Collection::
@end menu
@node Profiling Key Operations
@section @strong{TODO} Profiling Key Operations
@node Garbage Collection
@section Garbage Collection
During the cache-build process, Org-roam generates a lot of in-memory
data-structures (such as the Org file's AST), which are discarded after use. These structures are garbage collected at regular intervals (see @ref{Garbage Collection,info:elisp#Garbage Collection,,elisp,}).
Org-roam provides the option @code{org-roam-db-gc-threshold} to temporarily change
the threshold value for GC to be triggered during these memory-intensive
operations. To reduce the number of garbage collection processes, one may set
@code{org-roam-db-gc-threshold} to a high value (such as @code{most-positive-fixnum}):
@lisp
(setq org-roam-db-gc-threshold most-positive-fixnum)
@end lisp
@node Appendix
@chapter Appendix