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

Deploying to gh-pages from @ e5c735c86a 🚀

Browse Source
This commit is contained in:
jethrokuan
2021-07-20 07:10:26 +00:00
parent 972b27b1c6
commit 80387ade65
3 changed files with 25 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
manual.html
View File

@@ -131,8 +131,6 @@ Installation
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Installing-from-MELPA">Installing from MELPA</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-Apt">Installing from Apt</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-Source">Installing from Source</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installation-Troubleshooting">Installation Troubleshooting</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -454,18 +452,16 @@ development repository.
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-MELPA" accesskey="1">Installing from MELPA</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-Apt" accesskey="2">Installing from Apt</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-Source" accesskey="2">Installing from Source</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installing-from-Source" accesskey="3">Installing from Source</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Installation-Troubleshooting" accesskey="4">Installation Troubleshooting</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="#Installation-Troubleshooting" accesskey="3">Installation Troubleshooting</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<span id="Installing-from-MELPA"></span><div class="header">
<p>
Next: <a href="#Installing-from-Apt" accesskey="n" rel="next">Installing from Apt</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
Next: <a href="#Installing-from-Source" accesskey="n" rel="next">Installing from Source</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Installing-from-MELPA-1"></span><h3 class="section">4.1 Installing from MELPA</h3>
@@ -515,28 +511,12 @@ using:
<pre class="example">M-x package-install RET org-roam RET
</pre></div>
<hr>
<span id="Installing-from-Apt"></span><div class="header">
<p>
Next: <a href="#Installing-from-Source" accesskey="n" rel="next">Installing from Source</a>, Previous: <a href="#Installing-from-MELPA" accesskey="p" rel="prev">Installing from MELPA</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Installing-from-Apt-1"></span><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
using Apt:
</p>
<div class="example">
<pre class="example">apt-get install elpa-org-roam
</pre></div>
<p>Org-roam will then be autoloaded into Emacs.
</p>
<hr>
<span id="Installing-from-Source"></span><div class="header">
<p>
Next: <a href="#Installation-Troubleshooting" accesskey="n" rel="next">Installation Troubleshooting</a>, Previous: <a href="#Installing-from-Apt" accesskey="p" rel="prev">Installing from Apt</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
Next: <a href="#Installation-Troubleshooting" accesskey="n" rel="next">Installation Troubleshooting</a>, Previous: <a href="#Installing-from-MELPA" accesskey="p" rel="prev">Installing from MELPA</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Installing-from-Source-1"></span><h3 class="section">4.3 Installing from Source</h3>
<span id="Installing-from-Source-1"></span><h3 class="section">4.2 Installing from Source</h3>
<p>You may install Org-roam directly from the repository on <a href="https://github.com/org-roam/org-roam">GitHub</a> if you like.
This will give you access to the latest version hours or days before it appears
@@ -634,7 +614,7 @@ file:
<p>
Previous: <a href="#Installing-from-Source" accesskey="p" rel="prev">Installing from Source</a>, Up: <a href="#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Installation-Troubleshooting-1"></span><h3 class="section">4.4 Installation Troubleshooting</h3>
<span id="Installation-Troubleshooting-1"></span><h3 class="section">4.3 Installation Troubleshooting</h3>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#C-Compiler" accesskey="1">C Compiler</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -646,7 +626,7 @@ Previous: <a href="#Installing-from-Source" accesskey="p" rel="prev">Installing
<p>
Up: <a href="#Installation-Troubleshooting" accesskey="u" rel="up">Installation Troubleshooting</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="C-Compiler-1"></span><h4 class="subsection">4.4.1 C Compiler</h4>
<span id="C-Compiler-1"></span><h4 class="subsection">4.3.1 C Compiler</h4>
<p>Org-roam relies on an Emacs package called <code>emacsql</code> and <code>emacsql-sqlite</code> to
work with the <code>sqlite</code> database. Both of them should be installed automatically
@@ -797,7 +777,7 @@ Org-roam is available on startup, place this in your Emacs configuration:
(org-roam-setup)
</pre></div>
<p>To build the cache manually, run <code>M-x org-roam-db-build-cache</code>. Cache builds may
<p>To build the cache manually, run <code>M-x org-roam-db-sync</code>. Cache builds may
take a while the first time, but subsequent builds are often instantaneous
because they only reprocess modified files.
</p>
@@ -1004,14 +984,14 @@ Org-roam buffer.
example configuration should provide a good starting point:
</p>
<div class="lisp">
<pre class="lisp"> (add-to-list 'display-buffer-alist
'(&quot;\\*org-roam\\*&quot;
(display-buffer-in-side-window)
(side . right)
(slot . 0)
(window-width . 0.33)
(window-parameters . ((no-other-window . t)
(no-delete-other-windows . t)))))
<pre class="lisp">(add-to-list 'display-buffer-alist
'(&quot;\\*org-roam\\*&quot;
(display-buffer-in-side-window)
(side . right)
(slot . 0)
(window-width . 0.33)
(window-parameters . ((no-other-window . t)
(no-delete-other-windows . t)))))
</pre></div>
<hr>

11
org-roam.org
View File

@@ -198,17 +198,6 @@ using:
M-x package-install RET org-roam RET
#+END_EXAMPLE
** Installing from Apt
Users of Debian 11 or later or Ubuntu 20.10 or later can simply install Org-roam
using Apt:
#+BEGIN_SRC bash
apt-get install elpa-org-roam
#+END_SRC
Org-roam will then be autoloaded into Emacs.
** Installing from Source
You may install Org-roam directly from the repository on [[https://github.com/org-roam/org-roam][GitHub]] if you like.

32
org-roam.texi
View File

@@ -92,7 +92,6 @@ General Public License for more details.
Installation
* Installing from MELPA::
* Installing from Apt::
* Installing from Source::
* Installation Troubleshooting::
@@ -337,7 +336,6 @@ development repository.
@menu
* Installing from MELPA::
* Installing from Apt::
* Installing from Source::
* Installation Troubleshooting::
@end menu
@@ -393,18 +391,6 @@ using:
M-x package-install RET org-roam RET
@end example
@node Installing from Apt
@section Installing from Apt
Users of Debian 11 or later or Ubuntu 20.10 or later can simply install Org-roam
using Apt:
@example
apt-get install elpa-org-roam
@end example
Org-roam will then be autoloaded into Emacs.
@node Installing from Source
@section Installing from Source
@@ -654,7 +640,7 @@ Org-roam is available on startup, place this in your Emacs configuration:
(org-roam-setup)
@end lisp
To build the cache manually, run @code{M-x org-roam-db-build-cache}. Cache builds may
To build the cache manually, run @code{M-x org-roam-db-sync}. Cache builds may
take a while the first time, but subsequent builds are often instantaneous
because they only reprocess modified files.
@@ -844,14 +830,14 @@ For users that prefer using a side-window for the org-roam buffer, the following
example configuration should provide a good starting point:
@lisp
(add-to-list 'display-buffer-alist
'("\\*org-roam\\*"
(display-buffer-in-side-window)
(side . right)
(slot . 0)
(window-width . 0.33)
(window-parameters . ((no-other-window . t)
(no-delete-other-windows . t)))))
(add-to-list 'display-buffer-alist
'("\\*org-roam\\*"
(display-buffer-in-side-window)
(side . right)
(slot . 0)
(window-width . 0.33)
(window-parameters . ((no-other-window . t)
(no-delete-other-windows . t)))))
@end lisp
@node Styling the Org-roam buffer