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

(docs): Add documentation for #+ROAM_ALIAS attribute (#185)

Browse Source
This commit is contained in:
Jethro Kuan
2020-02-26 01:33:49 +08:00
committed by GitHub
parent a8d696e6e8
commit 5b96cf806f
2 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/anatomy.md Normal file
View File

@@ -0,0 +1,16 @@
The bulk of Org-roam's functionality is built on top of vanilla
Org-mode features. However, to support additional functionality,
Org-roam adds several Org-roam-specific keywords. This functionality
is not crucial to effective use of Org-roam.
## File Aliases
Suppose you want a note to be referred to by different names (e.g.
"World War 2", "WWII"). You may specify such aliases using the file
`#+ROAM_ALIAS` attribute:
```org
#+TITLE: World War 2
#+ROAM_ALIAS: "WWII" "World War II"
```

1
mkdocs.yml
View File

@@ -8,6 +8,7 @@ nav:
- A Tour of Org-Roam: tour.md
- Installation: installation.md
- Configuration: configuration.md
- Anatomy of a Roam file: anatomy.md
- Ecosystem: ecosystem.md
- Similar Packages: comparison.md
- "Appendix: Note-taking Workflow": notetaking_workflow.md