Skip to content

Metagen

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

Generate Neorg metadata

A Neorg module for generating document metadata automatically.

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

Configuration

type : One of "none" or "auto"

Default value: "none"

tab : How to generate a tabulation inside the @document.meta tag

Default value: ""

delimiter : Custom delimiter between tag and value

Default value: ": "

template : Custom template to use for generating content inside @document.meta tag

Default Value:

Developer Usage

Public API

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

  • construct_metadata
  • inject_metadata
  • is_metadata_present

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

Required by

This module isn't required by any other module.