Skip to content

Neorgcmd Module

github-actions[bot] edited this page Jun 25, 2022 · 250 revisions

Neorgcmd module for Neorg.

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

Overview

Usage

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.

Configuration

Developer Usage

Public API

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

  • add_commands
  • add_commands_from_file
  • function_callback
  • add_commands_from_table
  • sync
  • set_completion_callback

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.11. The current Neorg version is 0.0.11.

Imports

This module does not import any other files.

Requires

This module does not require any other modules to operate.

Required by