Org-roam User Manual
This manual is for Org-roam version 2.3.1-devel.
Copyright (C) 2020-2026 Jethro Kuan <jethrokuan95@gmail.com> and the Org-roam contributors
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
- Target Audience
- A Brief Introduction to the Zettelkasten Method
- Installation
- Getting Started
- Customizing Node Caching
- The Org-roam Buffer
- Node Properties
- Citations
- Completion
- Encryption
- The Templating System
- Extensions
- Performance Optimization
- The Org-mode Ecosystem
- FAQ
- Developer’s Guide to Org-roam
- Appendix
- Keystroke Index
- Command Index
- Function Index
- Variable Index