Skip to content

Nvim Cmp

github-actions[bot] edited this page Sep 23, 2022 · 201 revisions

Integrating Neorg with nvim-cmp

A module for integrating nvim-cmp with Neorg.

Overview

This module works with the core.norg.completion module to attempt to provide intelligent completions. Note that integrations like this are second-class citizens and may not work in 100% of scenarios. If they don't then please file a bug report!

After setting up core.norg.completion with the engine set to nvim-cmp, make sure to also set up "neorg" as a source in nvim-cmp:

sources = {
    { name = "neorg" },
},

Configuration

This module exposes no customization options.

Keybinds

This module defines no keybinds.

How to Apply

  • To manually load the module, place this code in your Neorg setup:
    ["core.integrations.nvim-cmp"] = {
       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.integrations.nvim-cmp to your liking.

Technical Information

Developer Usage

Public API

This segment will detail all of the functions core.integrations.nvim-cmp exposes. All of these functions reside in the public table.

  • create_source
  • create_abstracted_context

Examples

None Provided

Extra Info

Version

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

Imports

This module does not import any other files.

Requires

This module does not require any other modules to operate.

Required by

This module isn't required by any other module.