text2confl config

Configuration file for Text2Confl - tool to publish Markdown and Asciidoctor files to Confluence

Type object
File match **/.text2confl.yaml **/.text2confl.yml **/text2confl.yaml **/text2confl.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/text2confl-config/latest.json
Source https://raw.githubusercontent.com/zeldigas/text2confl/refs/heads/master/docs/config.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Configuration parameters for https://github.com/zeldigas/text2confl

Properties

server string

Confluence server URL. Must be <https://>.atlassian.net/wiki for Confluence Cloud

confluence-cloud boolean

Enables API V2 usage. true for Confluence Cloud by default. Specify only if you want to explicitly disable it for some reason

space string

Confluence space key where pages uploaded

default-parent-id string

Default parent page ID for root level pages. Takes precedence over default parent page title

default-parent string

Default parent page title for root level pages

remove-orphans string

Cleanup strategy for orphaned pages

Default: "managed"
Values: "none" "managed" "all"
notify-watchers boolean

Whether to notify page watchers on updates

Default: true
title-prefix string

Prefix to add to all page titles

Default: ""
title-postfix string

Postfix to add to all page titles

Default: ""
editor-version string

Editor version to use. If not specified, set to v1 for Confluence Server and to v2 for Confluence Cloud

Values: "v1" "v2"
modification-check string

Method to detect page modifications

Default: "hash"
Values: "hash" "content"
docs-location string

Url - location of documentation files. When specified, implicitly sets add-autogenerated-note to true as default value

add-autogenerated-note boolean

Whether to add autogenerated note to pages at the top of the page

autogenerated-note string

Custom autogenerated note text in Confluence Storage format

auto-fix-content-tags boolean

Whether to automatically fix converted content to make tag properly ordered

Default: false
tenant string

Tenant identifier for multi-tenant setups

code-blocks object

Configuration for code block processing

3 nested properties
default-language string

Default language for code blocks without explicit language tag

extra-mapping object

Additional mappings for language aliases. Use when to map language tags to values known by Confluence

collapse-with-expand boolean

Whether to wrap collapsible code blocks into expand macro. Activated by default for Confluence Cloud since code blocks in v2 editor does not support collapsing

markdown object

Configuration for Markdown processing

7 nested properties
any-macro boolean

Allow any Confluence macro in [SIMPLEMACRO ...] format. If no enabled macros explicitly configured, implicitly set to true

enabled-macros string[]

List of explicitly enabled Confluence macros in [SIMPLEMACRO ...] format

emoji boolean

Enable emoji support

Default: true
diagrams object

Configuration for diagram generation in Markdown

5 nested properties
temp-dir boolean

Use temporary directory for diagram generation

Default: false
base-dir string

Base directory for diagram files, relative to documentation directory

Default: ".diagrams"
mermaid object

Configuration for Mermaid diagram generation

6 nested properties
enabled boolean

Enable Mermaid diagram generation

Default: true
default-format string

Default output format for Mermaid diagrams

Default: "png"
Values: "png" "svg"
executable string

Path to Mermaid executable

Default: "mmdc"
config-file string

Path to Mermaid configuration file.

css-file string

Path to CSS file for Mermaid diagrams

puppeeter-config string

Path to Puppeteer configuration file

plantuml object

Configuration for PlantUML diagram generation

3 nested properties
enabled boolean

Enable PlantUML diagram generation

Default: true
executable string

Path to PlantUML executable

Default: "plantuml"
default-format string

Default output format for PlantUML diagrams

Default: "png"
Values: "svg" "png" "eps"
kroki object

Configuration for Kroki diagram generation

3 nested properties
enabled boolean

Enable Kroki diagram generation

Default: true
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
default-format string

Default output format for Kroki diagrams

Default: "png"
Values: "png" "svg"
auto-links boolean

Enable automatic link detection

Default: true
tables object

Configuration for table processing

4 nested properties
column-spans boolean

Enable column spans in tables

Default: true
discard-extra-columns boolean

Discard extra columns that don't fit the table structure

Default: true
append-missing-columns boolean

Append missing columns to match table structure

Default: true
header-separator-column-match boolean

Match header separator columns

Default: true
typography object

Configuration for typography processing

2 nested properties
quotes boolean

Enable smart quotes conversion

Default: false
smarts boolean

Enable smart typography features

Default: true
asciidoc object

Configuration for AsciiDoc processing

7 nested properties
gems string[]

Ruby gems to load for AsciiDoc processing

Default:
[]
diagrams string

Diagram support mode for AsciiDoc. none disables diagram rendering

Default: "Diagrams"
Values: "none" "diagrams" "kroki"
bundled-macros boolean

Load bundled AsciiDoc macros: status, user, confl_macro

Default: true
attributes object

AsciiDoc attributes to pass to the processor for all pages

Default:
{}
temp-dir boolean

Use temporary directory for AsciiDoc processing instead of base-dir

Default: false
base-dir string

Base directory for AsciiDoc internal files and generated diagrams. Relative to docs directory

Default: ".asciidoc"
kroki object

Parameters for Kroki diagram service

3 nested properties
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
fetch boolean

Whether to fetch diagrams from Kroki server and upload them as attachments instead of using links

Default: true
default-format string

Default output format for Kroki diagrams

client object

Parameters for http client

3 nested properties
skip-ssl boolean

Skip SSL certificate verification

Default: false
requests-per-seconds number

Activates requests rate limiting when provided. Use if requests rate is throttled by server

retry-on-too-many-requests boolean

Retry requests when server returns 429 or 503 status codes

Default: true

Definitions

CodeBlockParams object

Configuration for code block processing

default-language string

Default language for code blocks without explicit language tag

extra-mapping object

Additional mappings for language aliases. Use when to map language tags to values known by Confluence

collapse-with-expand boolean

Whether to wrap collapsible code blocks into expand macro. Activated by default for Confluence Cloud since code blocks in v2 editor does not support collapsing

MarkdownParams object

Configuration for Markdown processing

any-macro boolean

Allow any Confluence macro in [SIMPLEMACRO ...] format. If no enabled macros explicitly configured, implicitly set to true

enabled-macros string[]

List of explicitly enabled Confluence macros in [SIMPLEMACRO ...] format

emoji boolean

Enable emoji support

Default: true
diagrams object

Configuration for diagram generation in Markdown

5 nested properties
temp-dir boolean

Use temporary directory for diagram generation

Default: false
base-dir string

Base directory for diagram files, relative to documentation directory

Default: ".diagrams"
mermaid object

Configuration for Mermaid diagram generation

6 nested properties
enabled boolean

Enable Mermaid diagram generation

Default: true
default-format string

Default output format for Mermaid diagrams

Default: "png"
Values: "png" "svg"
executable string

Path to Mermaid executable

Default: "mmdc"
config-file string

Path to Mermaid configuration file.

css-file string

Path to CSS file for Mermaid diagrams

puppeeter-config string

Path to Puppeteer configuration file

plantuml object

Configuration for PlantUML diagram generation

3 nested properties
enabled boolean

Enable PlantUML diagram generation

Default: true
executable string

Path to PlantUML executable

Default: "plantuml"
default-format string

Default output format for PlantUML diagrams

Default: "png"
Values: "svg" "png" "eps"
kroki object

Configuration for Kroki diagram generation

3 nested properties
enabled boolean

Enable Kroki diagram generation

Default: true
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
default-format string

Default output format for Kroki diagrams

Default: "png"
Values: "png" "svg"
auto-links boolean

Enable automatic link detection

Default: true
tables object

Configuration for table processing

4 nested properties
column-spans boolean

Enable column spans in tables

Default: true
discard-extra-columns boolean

Discard extra columns that don't fit the table structure

Default: true
append-missing-columns boolean

Append missing columns to match table structure

Default: true
header-separator-column-match boolean

Match header separator columns

Default: true
typography object

Configuration for typography processing

2 nested properties
quotes boolean

Enable smart quotes conversion

Default: false
smarts boolean

Enable smart typography features

Default: true
MarkdownDiagramParameters object

Configuration for diagram generation in Markdown

temp-dir boolean

Use temporary directory for diagram generation

Default: false
base-dir string

Base directory for diagram files, relative to documentation directory

Default: ".diagrams"
mermaid object

Configuration for Mermaid diagram generation

6 nested properties
enabled boolean

Enable Mermaid diagram generation

Default: true
default-format string

Default output format for Mermaid diagrams

Default: "png"
Values: "png" "svg"
executable string

Path to Mermaid executable

Default: "mmdc"
config-file string

Path to Mermaid configuration file.

css-file string

Path to CSS file for Mermaid diagrams

puppeeter-config string

Path to Puppeteer configuration file

plantuml object

Configuration for PlantUML diagram generation

3 nested properties
enabled boolean

Enable PlantUML diagram generation

Default: true
executable string

Path to PlantUML executable

Default: "plantuml"
default-format string

Default output format for PlantUML diagrams

Default: "png"
Values: "svg" "png" "eps"
kroki object

Configuration for Kroki diagram generation

3 nested properties
enabled boolean

Enable Kroki diagram generation

Default: true
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
default-format string

Default output format for Kroki diagrams

Default: "png"
Values: "png" "svg"
AsciidocParams object

Configuration for AsciiDoc processing

gems string[]

Ruby gems to load for AsciiDoc processing

Default:
[]
diagrams string

Diagram support mode for AsciiDoc. none disables diagram rendering

Default: "Diagrams"
Values: "none" "diagrams" "kroki"
bundled-macros boolean

Load bundled AsciiDoc macros: status, user, confl_macro

Default: true
attributes object

AsciiDoc attributes to pass to the processor for all pages

Default:
{}
temp-dir boolean

Use temporary directory for AsciiDoc processing instead of base-dir

Default: false
base-dir string

Base directory for AsciiDoc internal files and generated diagrams. Relative to docs directory

Default: ".asciidoc"
kroki object

Parameters for Kroki diagram service

3 nested properties
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
fetch boolean

Whether to fetch diagrams from Kroki server and upload them as attachments instead of using links

Default: true
default-format string

Default output format for Kroki diagrams

KrokiDiagramsParameters object

Parameters for Kroki diagram service

server string

Kroki server URL

Default: "https://kroki.io"
format=uri
fetch boolean

Whether to fetch diagrams from Kroki server and upload them as attachments instead of using links

Default: true
default-format string

Default output format for Kroki diagrams

TablesConfiguration object

Configuration for table processing

column-spans boolean

Enable column spans in tables

Default: true
discard-extra-columns boolean

Discard extra columns that don't fit the table structure

Default: true
append-missing-columns boolean

Append missing columns to match table structure

Default: true
header-separator-column-match boolean

Match header separator columns

Default: true
TypographyConfiguration object

Configuration for typography processing

quotes boolean

Enable smart quotes conversion

Default: false
smarts boolean

Enable smart typography features

Default: true
MermaidDiagramsConfiguration object

Configuration for Mermaid diagram generation

enabled boolean

Enable Mermaid diagram generation

Default: true
default-format string

Default output format for Mermaid diagrams

Default: "png"
Values: "png" "svg"
executable string

Path to Mermaid executable

Default: "mmdc"
config-file string

Path to Mermaid configuration file.

css-file string

Path to CSS file for Mermaid diagrams

puppeeter-config string

Path to Puppeteer configuration file

PlantUmlDiagramsConfiguration object

Configuration for PlantUML diagram generation

enabled boolean

Enable PlantUML diagram generation

Default: true
executable string

Path to PlantUML executable

Default: "plantuml"
default-format string

Default output format for PlantUML diagrams

Default: "png"
Values: "svg" "png" "eps"
KrokiDiagramsConfiguration object

Configuration for Kroki diagram generation

enabled boolean

Enable Kroki diagram generation

Default: true
server string

Kroki server URL

Default: "https://kroki.io"
format=uri
default-format string

Default output format for Kroki diagrams

Default: "png"
Values: "png" "svg"
HttpClientParams object

Parameters for http client

skip-ssl boolean

Skip SSL certificate verification

Default: false
requests-per-seconds number

Activates requests rate limiting when provided. Use if requests rate is throttled by server

retry-on-too-many-requests boolean

Retry requests when server returns 429 or 503 status codes

Default: true