mirror of
https://github.com/org-roam/org-roam
synced 2025-08-31 14:43:32 -05:00
(docs): Add documentation for #+ROAM_ALIAS attribute (#185)
This commit is contained in:
16
doc/anatomy.md
Normal file
16
doc/anatomy.md
Normal 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"
|
||||||
|
```
|
||||||
|
|
@@ -8,6 +8,7 @@ nav:
|
|||||||
- A Tour of Org-Roam: tour.md
|
- A Tour of Org-Roam: tour.md
|
||||||
- Installation: installation.md
|
- Installation: installation.md
|
||||||
- Configuration: configuration.md
|
- Configuration: configuration.md
|
||||||
|
- Anatomy of a Roam file: anatomy.md
|
||||||
- Ecosystem: ecosystem.md
|
- Ecosystem: ecosystem.md
|
||||||
- Similar Packages: comparison.md
|
- Similar Packages: comparison.md
|
||||||
- "Appendix: Note-taking Workflow": notetaking_workflow.md
|
- "Appendix: Note-taking Workflow": notetaking_workflow.md
|
||||||
|
Reference in New Issue
Block a user