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

Deploying to gh-pages from @ eb7ee0ef6c 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-07-19 04:38:24 +00:00
parent 78a4b4662f
commit a289b99c77
10 changed files with 153 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
manual/Browsing-History-with-winner_002dmode.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="Ecosystem.html#Ecosystem" rel="up" title="Ecosystem">
<link href="Deft.html#Deft" rel="next" title="Deft">
<link href="Versioning-Notes.html#Versioning-Notes" rel="next" title="Versioning Notes">
<link href="Ecosystem.html#Ecosystem" rel="prev" title="Ecosystem">
<style type="text/css">
<!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Browsing-History-with-winner_002dmode"></a>
<div class="header">
<p>
Next: <a href="Deft.html#Deft" accesskey="n" rel="next">Deft</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Versioning-Notes.html#Versioning-Notes" accesskey="n" rel="next">Versioning Notes</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Browsing-History-with-winner_002dmode-1"></a>

4
manual/Diagnosing-and-Repairing-Files.html
View File

@@ -81,7 +81,9 @@ org-roam-doctor</code>, but note that this may take some time.
the check only for the current buffer.
</p></li></ul>
<p>The checks run are defined in <code>org-roam-doctor--checkers</code>. Each checker is an instance of <code>org-roam-doctor-checker</code>. To define a checker, use <code>make-org-roam-doctor-checker</code>. Here is a sample definition:
<p>The checks run are defined in <code>org-roam-doctor--checkers</code>. Each checker is an
instance of <code>org-roam-doctor-checker</code>. To define a checker, use
<code>make-org-roam-doctor-checker</code>. Here is a sample definition:
</p>
<div class="lisp">
<pre class="lisp">(make-org-roam-doctor-checker

10
manual/Ecosystem.html
View File

@@ -69,16 +69,16 @@ Previous: <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" acc
<a name="Ecosystem-1"></a>
<h3 class="section">16.2 Ecosystem</h3>
<p>A number of packages work well combined with Org-Roam:
</p>
<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">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Deft.html#Deft" accesskey="2">Deft</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Versioning-Notes.html#Versioning-Notes" accesskey="2">Versioning Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002djournal.html#Org_002djournal" accesskey="3">Org-journal</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft" accesskey="3">Full-text search interface with Deft</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" accesskey="4">Note-taking Add-ons</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Org_002djournal.html#Org_002djournal" accesskey="4">Org-journal</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" accesskey="5">Note-taking Add-ons</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

19
manual/Deft.html → manual/Full_002dtext-search-interface-with-Deft.html
View File

@@ -15,10 +15,10 @@ 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>Deft (Org-roam User Manual)</title>
<title>Full-text search interface with Deft (Org-roam User Manual)</title>
<meta name="description" content="Deft (Org-roam User Manual)">
<meta name="keywords" content="Deft (Org-roam User Manual)">
<meta name="description" content="Full-text search interface with Deft (Org-roam User Manual)">
<meta name="keywords" content="Full-text search interface with Deft (Org-roam User Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
@@ -26,7 +26,7 @@ General Public License for more details.
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Ecosystem.html#Ecosystem" rel="up" title="Ecosystem">
<link href="Org_002djournal.html#Org_002djournal" rel="next" title="Org-journal">
<link href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" rel="prev" title="Browsing History with winner-mode">
<link href="Versioning-Notes.html#Versioning-Notes" rel="prev" title="Versioning Notes">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -60,17 +60,16 @@ ul.no-bullet {list-style: none}
</head>
<body lang="en">
<a name="Deft"></a>
<a name="Full_002dtext-search-interface-with-Deft"></a>
<div class="header">
<p>
Next: <a href="Org_002djournal.html#Org_002djournal" accesskey="n" rel="next">Org-journal</a>, Previous: <a href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" accesskey="p" rel="prev">Browsing History with winner-mode</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Org_002djournal.html#Org_002djournal" accesskey="n" rel="next">Org-journal</a>, Previous: <a href="Versioning-Notes.html#Versioning-Notes" accesskey="p" rel="prev">Versioning Notes</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Deft-1"></a>
<h4 class="subsection">16.2.2 Deft</h4>
<a name="Full_002dtext-search-interface-with-Deft-1"></a>
<h4 class="subsection">16.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>
<div class="lisp">
<pre class="lisp">(use-package deft

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">16.2.4 Note-taking Add-ons</h4>
<h4 class="subsection">16.2.5 Note-taking Add-ons</h4>
<p>These are some plugins that make note-taking in Org-mode more enjoyable.
</p>

6
manual/Org_002djournal.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="Ecosystem.html#Ecosystem" rel="up" title="Ecosystem">
<link href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" rel="next" title="Note-taking Add-ons">
<link href="Deft.html#Deft" rel="prev" title="Deft">
<link href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft" rel="prev" title="Full-text search interface with Deft">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
<a name="Org_002djournal"></a>
<div class="header">
<p>
Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" accesskey="n" rel="next">Note-taking Add-ons</a>, Previous: <a href="Deft.html#Deft" accesskey="p" rel="prev">Deft</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" accesskey="n" rel="next">Note-taking Add-ons</a>, Previous: <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft" accesskey="p" rel="prev">Full-text search interface with Deft</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Org_002djournal-1"></a>
<h4 class="subsection">16.2.3 Org-journal</h4>
<h4 class="subsection">16.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

85
manual/Versioning-Notes.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>Versioning Notes (Org-roam User Manual)</title>
<meta name="description" content="Versioning Notes (Org-roam User Manual)">
<meta name="keywords" content="Versioning Notes (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="Ecosystem.html#Ecosystem" rel="up" title="Ecosystem">
<link href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft" rel="next" title="Full-text search interface with Deft">
<link href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" rel="prev" title="Browsing History with winner-mode">
<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="Versioning-Notes"></a>
<div class="header">
<p>
Next: <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft" accesskey="n" rel="next">Full-text search interface with Deft</a>, Previous: <a href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode" accesskey="p" rel="prev">Browsing History with winner-mode</a>, Up: <a href="Ecosystem.html#Ecosystem" accesskey="u" rel="up">Ecosystem</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Versioning-Notes-1"></a>
<h4 class="subsection">16.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
<code>org-roam-directory</code> as a Git repository, and commit your files at regular or
appropriate intervals. <a href="https://magit.vc/">Magit</a> is a great interface to Git within Emacs.
</p>
<p>In addition, it may be useful to observe how a particular note has evolved, by
looking at the file history. <a href="https://gitlab.com/pidu/git-timemachine">Git-timemachine</a> allows you to visit historic
versions of a tracked Org-roam note.
</p>
</body>
</html>

11
manual/index.html
View File

@@ -128,9 +128,10 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">16.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">16.2.1 Browsing History with winner-mode</a></li>
<li><a name="toc-Deft-1" href="Deft.html#Deft">16.2.2 Deft</a></li>
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">16.2.3 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.4 Note-taking Add-ons</a>
<li><a name="toc-Versioning-Notes-1" href="Versioning-Notes.html#Versioning-Notes">16.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-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">16.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>
<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>
@@ -300,7 +301,9 @@ Ecosystem
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Browsing-History-with-winner_002dmode.html#Browsing-History-with-winner_002dmode">Browsing History with winner-mode</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Deft.html#Deft">Deft</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Versioning-Notes.html#Versioning-Notes">Versioning Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Full_002dtext-search-interface-with-Deft.html#Full_002dtext-search-interface-with-Deft">Full-text search interface with Deft</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002djournal.html#Org_002djournal">Org-journal</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>

21
org-roam.org
View File

@@ -851,7 +851,9 @@ org-roam-doctor~, but note that this may take some time.
Perform a check on Org-roam files to ensure cleanliness. If THIS-BUFFER, run
the check only for the current buffer.
The checks run are defined in ~org-roam-doctor--checkers~. Each checker is an instance of ~org-roam-doctor-checker~. To define a checker, use ~make-org-roam-doctor-checker~. Here is a sample definition:
The checks run are defined in ~org-roam-doctor--checkers~. Each checker is an
instance of ~org-roam-doctor-checker~. To define a checker, use
~make-org-roam-doctor-checker~. Here is a sample definition:
#+BEGIN_SRC emacs-lisp
(make-org-roam-doctor-checker
@@ -920,7 +922,6 @@ General Public License for more details.
- Videos ::
- [[https://www.youtube.com/watch?v=RvWic15iXjk][How to Use Roam to Outline a New Article in Under 20 Minutes]]
** Ecosystem
A number of packages work well combined with Org-Roam:
*** Browsing History with winner-mode
@@ -934,13 +935,23 @@ A number of packages work well combined with Org-Roam:
(define-key winner-mode-map (kbd "<M-right>") #'winner-redo)
#+END_SRC
*** Deft
*** Versioning Notes
Since Org-roam notes are just plain text, it is trivial to track changes in your
notes database using version control systems such as [[https://git-scm.com/][Git]]. Simply initialize
~org-roam-directory~ as a Git repository, and commit your files at regular or
appropriate intervals. [[https://magit.vc/][Magit]] is a great interface to Git within Emacs.
In addition, it may be useful to observe how a particular note has evolved, by
looking at the file history. [[https://gitlab.com/pidu/git-timemachine][Git-timemachine]] allows you to visit historic
versions of a tracked Org-roam note.
*** Full-text search interface with Deft
:PROPERTIES:
:CUSTOM_ID: deft
:END:
[[https://jblevins.org/projects/deft/][Deft]] provides a nice interface
for browsing and filtering org-roam notes.
[[https://jblevins.org/projects/deft/][Deft]] provides a nice interface for browsing and filtering org-roam notes.
#+BEGIN_SRC emacs-lisp
(use-package deft

31
org-roam.texi
View File

@@ -138,7 +138,8 @@ Appendix
Ecosystem
* Browsing History with winner-mode::
* Deft::
* Versioning Notes::
* Full-text search interface with Deft::
* Org-journal::
* Note-taking Add-ons::
@@ -1155,7 +1156,9 @@ Perform a check on Org-roam files to ensure cleanliness. If THIS-BUFFER, run
the check only for the current buffer.
@end itemize
The checks run are defined in @code{org-roam-doctor--checkers}. Each checker is an instance of @code{org-roam-doctor-checker}. To define a checker, use @code{make-org-roam-doctor-checker}. Here is a sample definition:
The checks run are defined in @code{org-roam-doctor--checkers}. Each checker is an
instance of @code{org-roam-doctor-checker}. To define a checker, use
@code{make-org-roam-doctor-checker}. Here is a sample definition:
@lisp
(make-org-roam-doctor-checker
@@ -1246,11 +1249,10 @@ operations. To reduce the number of garbage collection processes, one may set
@node Ecosystem
@section Ecosystem
A number of packages work well combined with Org-Roam:
@menu
* Browsing History with winner-mode::
* Deft::
* Versioning Notes::
* Full-text search interface with Deft::
* Org-journal::
* Note-taking Add-ons::
@end menu
@@ -1269,11 +1271,22 @@ A number of packages work well combined with Org-Roam:
@end lisp
@node Deft
@subsection Deft
@node Versioning Notes
@subsection Versioning Notes
@uref{https://jblevins.org/projects/deft/, Deft} provides a nice interface
for browsing and filtering org-roam notes.
Since Org-roam notes are just plain text, it is trivial to track changes in your
notes database using version control systems such as @uref{https://git-scm.com/, Git}. Simply initialize
@code{org-roam-directory} as a Git repository, and commit your files at regular or
appropriate intervals. @uref{https://magit.vc/, Magit} is a great interface to Git within Emacs.
In addition, it may be useful to observe how a particular note has evolved, by
looking at the file history. @uref{https://gitlab.com/pidu/git-timemachine, Git-timemachine} allows you to visit historic
versions of a tracked Org-roam note.
@node Full-text search interface with Deft
@subsection Full-text search interface with Deft
@uref{https://jblevins.org/projects/deft/, Deft} provides a nice interface for browsing and filtering org-roam notes.
@lisp
(use-package deft