Markdown Outline

Markdown Outline (markdown-outline)

Parse Markdown documents into structured outline data.

Transform Text json

Minimal example

actions:
  - markdown-outline: {}

JSON

{
  "actions": [
    {
      "markdown-outline": {}
    }
  ]
}

Contents

• Minimal example

• Fields

• General

• Input

• Parsing

• Output

Fields

Field	Type	Required	Description
description General	string		describe this step.
condition General	lua-expression (string)		Only run this action if the specified condition is met. Examples: 2 * count()
input-field Input	field (string)		Field containing Markdown data, default is ‘_raw’. Examples: data_field
max-heading-level Parsing	number (integer)		Highest heading level to include (1 = H1, 6 = H6). Examples: 42, 1.2e-10
tokens Parsing	string[]		Additional tokens (words or phrases) that should be indexed.
include-tables Output	boolean (bool)		Include tables in the emitted outline metadata.
include-media Output	boolean (bool)		Include images and media references in the outline metadata.
emit-summary Output	boolean (bool)		Emit a short summary paragraph when available.
outline-field Output	field (string)		Field to store the structured outline (defaults to ‘outline’). Examples: data_field
references-field Output	field (string)		Field to store graph/table metadata (defaults to ‘outline_graphs’). Examples: data_field
summary-field Output	field (string)		Field to store summary text (defaults to ‘outline_summary’). Examples: data_field

General

Show fields

Field	Type	Required	Description
description	string		describe this step.
condition	lua-expression (string)		Only run this action if the specified condition is met. Examples: 2 * count()

Input

Show fields

Field	Type	Required	Description
input-field	field (string)		Field containing Markdown data, default is ‘_raw’. Examples: data_field

Parsing

Show fields

Field	Type	Required	Description
max-heading-level	number (integer)		Highest heading level to include (1 = H1, 6 = H6). Examples: 42, 1.2e-10
tokens	string[]		Additional tokens (words or phrases) that should be indexed.

Output

Show fields

Field	Type	Required	Description
include-tables	boolean (bool)		Include tables in the emitted outline metadata.
include-media	boolean (bool)		Include images and media references in the outline metadata.
emit-summary	boolean (bool)		Emit a short summary paragraph when available.
outline-field	field (string)		Field to store the structured outline (defaults to ‘outline’). Examples: data_field
references-field	field (string)		Field to store graph/table metadata (defaults to ‘outline_graphs’). Examples: data_field
summary-field	field (string)		Field to store summary text (defaults to ‘outline_summary’). Examples: data_field