Org-roam User Manual

Table of Contents

Next: , Up: (dir)   [Contents]

Org-roam User Manual

This manual is for Org-roam version 1.2.0.

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.

• Introduction:  
• A Brief Introduction to the Zettelkasten Method:  
• Installation:  
• Getting Started:  
• Anatomy of an Org-roam File:  
• The Templating System:  
• Concepts and Configuration:  
• Navigating Around:  
• Encryption:  
• Graphing:  
• Org-roam Completion System:  
• Roam Protocol:  
• Daily Notes:  
• Diagnosing and Repairing Files:  
• Appendix:  
• FAQ:   


— The Detailed Node Listing —

Installation
• Installing from MELPA:  
• Installing from the Git Repository:  
• Post-Installation Tasks:   

Anatomy of an Org-roam File
• Titles:  
• Tags:  
• File Refs:   

The Templating System
• Template Walkthrough:  
• Org-roam Template Expansion:   

Concepts and Configuration
• Directories and Files:  
• The Org-roam Buffer:  
• Org-roam Links:  
• Org-roam Files:   

Navigating Around
• Index File:   

Graphing
• Graph Options:  
• Excluding Nodes and Edges:   

Roam Protocol
• _:  
• Installation:  
• The ‘roam-file’ protocol:  
• The ‘roam-ref’ Protocol:   

Appendix
• Note-taking Workflows:  
• Ecosystem:   

Ecosystem
• Deft:  
• Org-journal:  
• Note-taking Add-ons:   


FAQ
• How do I have more than one Org-roam directory?:  
• How do I migrate from Roam Research?:  

Next: , Up: (dir)   [Contents]