Dirman - nvim-neorg/neorg Wiki

Directory manager for Neorg.

Summary

This module is be responsible for managing directories full of .norg files.

Overview

It will provide other modules the ability to see which directories the user is in, automatically changing directories, and other API bits and bobs that will allow things like telescope.nvim integration.

To use core.norg.dirman, simply load up the module in your configuration and specify the directories you want to be managed for you:

require('neorg').setup {
    load = {
        ["core.defaults"] = {},
        ["core.norg.dirman"] = {
            config = {
                workspaces = {
                    my_ws = "~/neorg", -- Format: <name_of_workspace> = <path_to_workspace_root>
                    my_other_notes = "~/work/notes",
                },
                autochdir = true, -- Automatically change the directory to the current workspace's root every time
                index = "index.norg", -- The name of the main (root) .norg file
                last_workspace = vim.fn.stdpath("cache") .. "/neorg_last_workspace.txt" -- The location to write and read the workspace cache file
            }
        }
    }
}

To query the current workspace, run :Neorg workspace. To set the workspace, run :Neorg workspace <workspace_name>.

Usage

How to Apply

Configuration

The list of active workspaces

{
default = vim.fn.getcwd(),
},

Automatically change the directory to the root of the workspace every time

false

The name for the index file

"index.norg"

The location where to look for the last workspace

vim.fn.stdpath("cache") .. "/neorg_last_workspace.txt"

Developer Usage

Public API

This segment will detail all of the functions core.norg.dirman exposes. All of these functions reside in the public table.

Examples

None Provided

Extra Info

Version

This module supports at least version 0.0.9. The current Neorg version is 0.0.9.

Imports

This module does not import any other files.

Requires

Required by