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

Deploying to gh-pages from @ 4d992ce9e3 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-07-23 14:46:53 +00:00
parent a289b99c77
commit 6b2bcca985
8 changed files with 125 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
manual/Installation.html
View File

@@ -75,9 +75,11 @@ development repository.
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="1">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="1">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="2">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="2">Installing from Apt</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="3">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="3">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="4">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
</table> </table>

85
manual/Installing-from-Apt.html Normal file
View File

@@ -0,0 +1,85 @@
<!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>Installing from Apt (Org-roam User Manual)</title>
<meta name="description" content="Installing from Apt (Org-roam User Manual)">
<meta name="keywords" content="Installing from Apt (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="Installation.html#Installation" rel="up" title="Installation">
<link href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" rel="next" title="Installing from the Git Repository">
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="prev" title="Installing from MELPA">
<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="Installing-from-Apt"></a>
<div class="header">
<p>
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Previous: <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="p" rel="prev">Installing from MELPA</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Installing-from-Apt-1"></a>
<h3 class="section">3.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>
</body>
</html>

4
manual/Installing-from-MELPA.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#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Installation.html#Installation" rel="up" title="Installation"> <link href="Installation.html#Installation" rel="up" title="Installation">
<link href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" rel="next" title="Installing from the Git Repository"> <link href="Installing-from-Apt.html#Installing-from-Apt" rel="next" title="Installing from Apt">
<link href="Installation.html#Installation" rel="prev" title="Installation"> <link href="Installation.html#Installation" rel="prev" title="Installation">
<style type="text/css"> <style type="text/css">
<!-- <!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Installing-from-MELPA"></a> <a name="Installing-from-MELPA"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="n" rel="next">Installing from Apt</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>
<hr> <hr>
<a name="Installing-from-MELPA-1"></a> <a name="Installing-from-MELPA-1"></a>

6
manual/Installing-from-the-Git-Repository.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#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Installation.html#Installation" rel="up" title="Installation"> <link href="Installation.html#Installation" rel="up" title="Installation">
<link href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" rel="next" title="Post-Installation Tasks"> <link href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" rel="next" title="Post-Installation Tasks">
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="prev" title="Installing from MELPA"> <link href="Installing-from-Apt.html#Installing-from-Apt" rel="prev" title="Installing from Apt">
<style type="text/css"> <style type="text/css">
<!-- <!--
a.summary-letter {text-decoration: none} a.summary-letter {text-decoration: none}
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
<a name="Installing-from-the-Git-Repository"></a> <a name="Installing-from-the-Git-Repository"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="n" rel="next">Post-Installation Tasks</a>, Previous: <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="p" rel="prev">Installing from MELPA</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="n" rel="next">Post-Installation Tasks</a>, Previous: <a href="Installing-from-Apt.html#Installing-from-Apt" accesskey="p" rel="prev">Installing from Apt</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</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.2 <strong>TODO</strong> Installing from the Git Repository</h3> <h3 class="section">3.3 <strong>TODO</strong> Installing from the Git Repository</h3>

2
manual/Post_002dInstallation-Tasks.html
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.3 Post-Installation Tasks</h3> <h3 class="section">3.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

7
manual/index.html
View File

@@ -75,8 +75,9 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Installation-1" href="Installation.html#Installation">3 Installation</a> <li><a name="toc-Installation-1" href="Installation.html#Installation">3 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">3.1 Installing from MELPA</a></li>
<li><a name="toc-TODO-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">3.2 <strong>TODO</strong> Installing from the Git Repository</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-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">3.3 Post-Installation Tasks</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-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">3.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">4 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">5 Anatomy of an Org-roam File</a>
@@ -219,6 +220,8 @@ Installation
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> </pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installing-from-Apt.html#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-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

11
org-roam.org
View File

@@ -152,6 +152,17 @@ using:
Now see [[*Post-Installation Tasks][Post-Installation Tasks]]. Now see [[*Post-Installation Tasks][Post-Installation Tasks]].
** 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.
** TODO Installing from the Git Repository ** TODO Installing from the Git Repository
** Post-Installation Tasks ** Post-Installation Tasks

14
org-roam.texi
View File

@@ -88,6 +88,7 @@ General Public License for more details.
Installation Installation
* Installing from MELPA:: * Installing from MELPA::
* Installing from Apt::
* Installing from the Git Repository:: * Installing from the Git Repository::
* Post-Installation Tasks:: * Post-Installation Tasks::
@@ -239,6 +240,7 @@ development repository.
@menu @menu
* Installing from MELPA:: * Installing from MELPA::
* Installing from Apt::
* Installing from the Git Repository:: * Installing from the Git Repository::
* Post-Installation Tasks:: * Post-Installation Tasks::
@end menu @end menu
@@ -296,6 +298,18 @@ M-x package-install RET org-roam RET
Now see @ref{Post-Installation Tasks}. Now see @ref{Post-Installation Tasks}.
@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 the Git Repository @node Installing from the Git Repository
@section @strong{TODO} Installing from the Git Repository @section @strong{TODO} Installing from the Git Repository