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

Deploying to gh-pages from @ 5d483f2d4d 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-10-19 05:47:37 +00:00
parent 4a57007ed4
commit 75574a99af
7 changed files with 147 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
manual/Concepts-and-Configuration.html
View File

@@ -83,6 +83,8 @@ many usage styles as possible.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002droam-Files.html#Org_002droam-Files" accesskey="3">Org-roam Files</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002droam-Faces.html#Org_002droam-Faces" accesskey="4">Org-roam Faces</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

2
manual/Inserting-Links.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="Navigating-Around.html#Navigating-Around" rel="next" title="Navigating Around">
<link href="Org_002droam-Files.html#Org_002droam-Files" rel="prev" title="Org-roam Files">
<link href="Org_002droam-Faces.html#Org_002droam-Faces" rel="prev" title="Org-roam Faces">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}

95
manual/Org_002droam-Faces.html Normal file
View File

@@ -0,0 +1,95 @@
<!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>Org-roam Faces (Org-roam User Manual)</title>
<meta name="description" content="Org-roam Faces (Org-roam User Manual)">
<meta name="keywords" content="Org-roam Faces (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="Concepts-and-Configuration.html#Concepts-and-Configuration" rel="up" title="Concepts and Configuration">
<link href="Inserting-Links.html#Inserting-Links" rel="next" title="Inserting Links">
<link href="Org_002droam-Files.html#Org_002droam-Files" rel="prev" title="Org-roam 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="Org_002droam-Faces"></a>
<div class="header">
<p>
Previous: <a href="Org_002droam-Files.html#Org_002droam-Files" accesskey="p" rel="prev">Org-roam Files</a>, Up: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Org_002droam-Faces-1"></a>
<h3 class="section">8.4 Org-roam Faces</h3>
<p>Org-roam introduces several faces to distinguish links within the same buffer.
These faces are enabled by default in Org-roam notes.
</p>
<ul>
<li> User Option: org-roam-link-use-custom-faces
<p>When <code>t</code>, use custom faces only inside Org-roam notes.
When <code>everywhere</code>, the custom face is applied additionally to non Org-roam notes.
When <code>nil</code>, do not use Org-roam&rsquo;s custom faces.
</p></li></ul>
<p>The <code>org-roam-link</code> face is the face applied to links to other Org-roam files.
This distinguishes internal links from external links (e.g. external web links).
</p>
<p>The <code>org-roam-link-current</code> face corresponds to links to the same file it is in.
</p>
<p>The <code>org-roam-link-invalid</code> face is applied to links that are broken. These are
links to files or IDs that cannot be found.
</p>
</body>
</html>

4
manual/Org_002droam-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="Concepts-and-Configuration.html#Concepts-and-Configuration" rel="up" title="Concepts and Configuration">
<link href="Inserting-Links.html#Inserting-Links" rel="next" title="Inserting Links">
<link href="Org_002droam-Faces.html#Org_002droam-Faces" rel="next" title="Org-roam Faces">
<link href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer" rel="prev" title="The Org-roam Buffer">
<style type="text/css">
<!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Org_002droam-Files"></a>
<div class="header">
<p>
Previous: <a href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer" accesskey="p" rel="prev">The Org-roam Buffer</a>, Up: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Org_002droam-Faces.html#Org_002droam-Faces" accesskey="n" rel="next">Org-roam Faces</a>, Previous: <a href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer" accesskey="p" rel="prev">The Org-roam Buffer</a>, Up: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Org_002droam-Files-1"></a>

3
manual/index.html
View File

@@ -97,6 +97,7 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Directories-and-Files-1" href="Directories-and-Files.html#Directories-and-Files">8.1 Directories and Files</a></li>
<li><a name="toc-The-Org_002droam-Buffer-1" href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">8.2 The Org-roam Buffer</a></li>
<li><a name="toc-Org_002droam-Files-1" href="Org_002droam-Files.html#Org_002droam-Files">8.3 Org-roam Files</a></li>
<li><a name="toc-Org_002droam-Faces-1" href="Org_002droam-Faces.html#Org_002droam-Faces">8.4 Org-roam Faces</a></li>
</ul></li>
<li><a name="toc-Inserting-Links-1" href="Inserting-Links.html#Inserting-Links">9 Inserting Links</a></li>
<li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">10 Navigating Around</a>
@@ -263,6 +264,8 @@ Concepts and Configuration
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002droam-Files.html#Org_002droam-Files">Org-roam Files</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002droam-Faces.html#Org_002droam-Faces">Org-roam Faces</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">
Navigating Around

20
org-roam.org
View File

@@ -614,6 +614,25 @@ The Org-roam buffer displays backlinks for the currently active Org-roam note.
Org-roam files are created and prefilled using Org-roam's templating
system. The templating system is customizable (see [[*The Templating System][The Templating System]]).
** Org-roam Faces
Org-roam introduces several faces to distinguish links within the same buffer.
These faces are enabled by default in Org-roam notes.
- User Option: org-roam-link-use-custom-faces
When ~t~, use custom faces only inside Org-roam notes.
When ~everywhere~, the custom face is applied additionally to non Org-roam notes.
When ~nil~, do not use Org-roam's custom faces.
The ~org-roam-link~ face is the face applied to links to other Org-roam files.
This distinguishes internal links from external links (e.g. external web links).
The ~org-roam-link-current~ face corresponds to links to the same file it is in.
The ~org-roam-link-invalid~ face is applied to links that are broken. These are
links to files or IDs that cannot be found.
* Inserting Links
The preferred mode of linking is via ~file~ links to files, and ~id~ links for
@@ -672,7 +691,6 @@ To easily insert ~roam~ links, one may wish to use a package like [[https://gith
harder to edit. Defaults to ~t~.
* Navigating Around
** Index File
As your collection grows, you might want to create an index where you keep links

25
org-roam.texi
View File

@@ -111,6 +111,7 @@ Concepts and Configuration
* Directories and Files::
* The Org-roam Buffer::
* Org-roam Files::
* Org-roam Faces::
Navigating Around
@@ -783,6 +784,7 @@ All of Org-roam's customization options can be viewed via
* Directories and Files::
* The Org-roam Buffer::
* Org-roam Files::
* Org-roam Faces::
@end menu
@node Directories and Files
@@ -858,6 +860,29 @@ For example one can prevent the window from being deleted when calling
Org-roam files are created and prefilled using Org-roam's templating
system. The templating system is customizable (see @ref{The Templating System}).
@node Org-roam Faces
@section Org-roam Faces
Org-roam introduces several faces to distinguish links within the same buffer.
These faces are enabled by default in Org-roam notes.
@itemize
@item
User Option: org-roam-link-use-custom-faces
When @code{t}, use custom faces only inside Org-roam notes.
When @code{everywhere}, the custom face is applied additionally to non Org-roam notes.
When @code{nil}, do not use Org-roam's custom faces.
@end itemize
The @code{org-roam-link} face is the face applied to links to other Org-roam files.
This distinguishes internal links from external links (e.g. external web links).
The @code{org-roam-link-current} face corresponds to links to the same file it is in.
The @code{org-roam-link-invalid} face is applied to links that are broken. These are
links to files or IDs that cannot be found.
@node Inserting Links
@chapter Inserting Links