Neorgcmd Module

Neorgcmd module for Neorg.

This module deals with handling everything related to the :Neorg command.

Overview

Configuration

Keybinds

This module defines no keybinds.

How to Apply

• This module is already present in the core.defaults metamodule. You can load the module with:

  ["core.defaults"] = {},

  In your Neorg setup.
• To manually load the module, place this code in your Neorg setup:

  ["core.neorgcmd"] = {
     config = { -- Note that this table is optional and doesn't need to be provided
         -- Configuration here
     }
  }

  Consult the configuration section to see how you can configure core.neorgcmd to your liking.

---

Technical Information

Developer Usage

Public API

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

• sync
• add_commands_from_file
• add_commands
• set_completion_callback
• add_commands_from_table

Examples

Adding a Neorg command

-- In your module.setup(), make sure to require core.neorgcmd (requires = { "core.neorgcmd" })

Extra Info

Version

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

Imports

This module does not import any other files.

Requires

This module does not require any other modules to operate.

Required by

• core.integrations.treesitter - A module designed to integrate TreeSitter into Neorg.
• core.norg.dirman - This module is be responsible for managing directories full of .norg files.
• core.norg.journal - Easily create files for a journal.
• core.norg.news - Handles the displaying of Neorg news and other forms of media in a popup.
• core.neorgcmd.commands.return - Return to last location before entering Neorg.
• core.norg.qol.toc - Generates a Table of Content from the Neorg file.
• core.neorgcmd.commands.module.list - List loaded modules.
• core.neorgcmd.commands.module.load - Load a new module dynamically.
• core.keybinds - Module for managing keybindings with Neorg mode support.