Skip to content

Esupports Hop

github-actions[bot] edited this page Jun 23, 2022 · 212 revisions

Jump from Neorg links

"Hop" between Neorg links, following them with a single keypress.

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.norg.esupports.hop"] = {
       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.norg.esupports.hop to your liking.

Configuration

external_filetypes : List of strings specifying which filetypes to open in an external application

Default Value:

Developer Usage

Public API

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

  • extract_link_node
  • locate_anchor_declaration_target
  • locate_link_target
  • lookahead_link_node
  • follow_link
  • parse_link

Examples

None Provided

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

  • core.keybinds - Module for managing keybindings with Neorg mode support.
  • core.integrations.treesitter - A module designed to integrate TreeSitter into Neorg.
  • core.ui - A set of public functions to help developers create and manage UI (selection popups, prompts...) in their modules.
  • core.norg.dirman.utils - undocumented module

Required by