Skip to content

Treesitter Integration

github-actions[bot] edited this page Nov 17, 2023 · 393 revisions

core.integrations.treesitter

Snazzy Treesitter Integration

module-showcase

Configuration

  • configure_parsers
    (boolean)

    If true will auto-configure the parsers to use the recommended setup. Set to false only if you know what you're doing, or if the setting messes with your personal configuration.

    true
  • install_parsers
    (boolean)

    If true will automatically install Norg parsers if they are not present.

    true
  • parser_configs
    (table)

    Configurations for each parser as required by nvim-treesitter. If you would like to tweak your parser configs you may do so here.

    • norg
      (table)

      Configuration for the mainline norg parser.

      • branch
        (string)

        "main"
      • files
        (list)

        • (string)
          "src/parser.c"
        • (string)
          "src/scanner.cc"
      • revision
        (string)

        "6348056b999f06c2c7f43bb0a5aa7cfde5302712"
      • url
        (string)

        "https://github.com/nvim-neorg/tree-sitter-norg"
    • norg_meta
      (table)

      Configuration for the metadata parser (used to parse the contents of @document.meta blocks).

      • branch
        (string)

        "main"
      • files
        (list)

        • (string)
          "src/parser.c"
      • revision
        (string)

        "a479d1ca05848d0b51dd25bc9f71a17e0108b240"
      • url
        (string)

        "https://github.com/nvim-neorg/tree-sitter-norg-meta"

Required Modules

  • core.highlights - Manages your highlight groups with this module.
  • core.mode - Modes are a way of isolating different parts of Neorg based on the current mode.

Required By

  • core.clipboard - A module to manipulate and interact with the user's clipboard.
  • core.completion - A wrapper to interface with several different completion engines.
  • core.concealer - Enhances the basic Neorg experience by using icons instead of text.
  • core.esupports.hop - "Hop" between Neorg links, following them with a single keypress.
  • core.esupports.indent - A set of instructions for Neovim to indent Neorg documents.
  • core.esupports.metagen - A Neorg module for generating document metadata automatically.
  • core.export - Exports Neorg documents into any other supported filetype.
  • core.export.markdown - Interface for core.export to allow exporting to markdown.
  • core.itero - Module designed to continue lists, headings and other iterables.
  • core.journal - Easily track a journal within Neorg.
  • core.looking-glass - Allows for editing of code blocks within a separate buffer.
  • core.manoeuvre - A Neorg module for moving around different elements up and down.
  • core.pivot - Toggles the type of list currently under the cursor.
  • core.presenter - Neorg module to create gorgeous presentation slides.
  • core.promo - Promotes or demotes nestable items within Neorg files.
  • core.qol.toc - Generates a table of contents for a given Norg buffer.
  • core.qol.todo_items - Module for implementing todo lists.
  • core.queries.native - TS wrapper in order to fetch nodes using a custom table.
  • core.summary - Creates links to all files in any workspace.
  • core.syntax - Handles interaction for syntax files for code blocks.
  • core.tangle - An Advanced Code Block Exporter.
  • core.upgrade - Converts old versions of the Norg syntax to newer ones.
Clone this wiki locally