Up: Navigating Around   [Contents]


10.1 Index File

As your collection grows, you might want to create an index where you keep links to your main files.

In Org-roam, you can define the path to your index file by setting org-roam-index-file.

Variable: org-roam-index-file

Path to the Org-roam index file.

The path can be a string or a function. If it is a string, it should be the path (absolute or relative to org-roam-directory) to the index file. If it is is a function, the function should return the path to the index file. Otherwise, the index is assumed to be a note in org-roam-index whose title is "Index".

Function: org-roam-find-index

Opens the Index file in the current org-roam-directory.