Command reference

edit

Synopsis

Meziantou.Framework.AtlassianDataFormat.Tool [options]

Description

Convert Atlassian Document Format (ADF) documents to Markdown using Meziantou.Framework.AtlassianDataFormat

Options

OptionDescriptionDefault
--input <input>Path to the ADF JSON file to convert. If omitted, reads from stdin
--output <output>Path to the Markdown file to write. If omitted, writes to stdout
--heading-style <Atx\|Setext>Style used for headingsAtx
--emphasis-marker <Asterisk\|Underscore>Marker used for emphasisAsterisk
--code-block-style <Fenced\|Indented>Style used for code blocksFenced
--code-block-fence-character <code-block-fence-character>Fence character used for fenced code blocks`
--unordered-list-marker <unordered-list-marker>Marker used for unordered lists-
--thematic-break <thematic-break>Text used for horizontal rules---
--line-break-style <Backslash\|TrailingSpaces>Style used for line breaksTrailingSpaces
--panel-style <Blockquote\|GitHubAlert\|Html\|PlainText>Style used for panelsBlockquote
--expand-style <Blockquote\|Heading\|HtmlDetails>Style used for collapsible sectionsBlockquote
--table-style <Auto\|Html\|PipeTable>Style used for tablesPipeTable
--media-rendering <AltText\|Image\|Link\|Skip>Rendering used for media itemsImage
--emoji-rendering <ShortName\|Text>Rendering used for emojiText
--task-list-style <Checkbox\|PlainText>Style used for task listsCheckbox
--decision-list-style <BulletList\|PlainText>Style used for decision listsBulletList
--unknown-node-handling <KeepContent\|Skip\|Throw>Handling of nodes whose type is not part of the supported schemaSkip
--mention-format <mention-format>Format used for mentions, where {text} is the display name and {id} the account identifier@{text}
--status-format <status-format>Format used for status lozenges, where {text} is the text and {color} the color`{text}`
--date-format <date-format>Format used for dates, applied with the invariant cultureyyyy-MM-dd
-?, -h, --helpShow help and usage information
--versionShow version information