Skip to content
github-actions[bot] edited this page Sep 23, 2022 · 101 revisions

Syntax Module for Neorg

Handles interaction for syntax files for code blocks.


Author's note:
This module will appear as spaghetti code at first glance. This is intenional.
If one needs to edit this module, it is best to talk to me at katawful on GitHub.
Any edit is assumed to break this module


note that these come from core.norg.concealer as well

Default Value:


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

Technical Information

Developer Usage

Public API

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

  • sync_regex_code_blocks
  • remove_syntax
  • trigger_highlight_regex_code_block
  • check_code_block_type


None Provided

Extra Info


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


This module does not import any other files.


Required by

This module isn't required by any other module.