mark/README.md

Mark

Mark — a tool for syncing your markdown documentation with Atlassian Confluence pages.

This is very useful if you store documentation to your software in a Git repository and don't want to do an extra job of updating Confluence page using a tinymce wysiwyg enterprise core editor which always breaks everything.

Mark does the same but in a different way. Mark reads your markdown file, creates a Confluence page if it's not found by its name, uploads attachments, translates Markdown into HTML and updates the contents of the page via REST API. It's like you don't even need to create sections/pages in your Confluence anymore, just use them in your Markdown documentation.

Mark uses an extended file format, which, still being valid markdown, contains several HTML-ish metadata headers, which can be used to locate page inside Confluence instance and update it accordingly.

File in the extended format should follow the specification:

<!-- Space: <space key> -->
<!-- Parent: <parent 1> -->
<!-- Parent: <parent 2> -->
<!-- Title: <title> -->
<!-- Attachment: <local path> -->
<!-- Label: <label 1> -->
<!-- Label: <label 2> -->
<!-- Image-Align: <left|center|right> -->

<page contents>

There can be any number of Parent headers, if Mark can't find specified parent by title, Mark creates it.

Also, optional following headers are supported:

<!-- Layout: (article|plain) -->

• (default) article: content will be put in narrow column for ease of reading;
• plain: content will fill all page;

<!-- Type: (page|blogpost) -->

• (default) page: normal Confluence page - defaults to this if omitted
• blogpost: Blog post in Space. Cannot have Parent(s)

<!-- Content-Appearance: (full-width|fixed) -->

• (default) full-width: content will fill the full page width
• fixed: content will be rendered in a fixed narrow view

<!-- Sidebar: <h2>Test</h2> -->

Setting the sidebar creates a column on the right side. You're able to add any valid HTML content. Adding this property sets the layout to article.

<!-- Emoji: 🚀 -->

You can set a page emoji icon by specifying the icon in the headers.

<!-- Image-Align: center -->

You can set the alignment for all images in the page. Common values are left, center, and right. Can also be set globally via the --image-align CLI option (per-page header takes precedence).

Note: Images with width >= 760px automatically use center instead of the configured alignment, as Confluence requires this for wide images.

Mark supports Go templates, which can be included into article by using path to the template relative to current working dir, e.g.:

<!-- Include: <path> -->

If the template cannot be found relative to the current directory, a fallback directory can be defined via --include-path. This way it is possible to have global include files while local ones will still take precedence.

Optionally the delimiters can be defined:

<!-- Include: <path>
     Delims: "<<", ">>"
     -->

Or they can be switched off to disable processing:

<!-- Include: <path>
     Delims: none
     -->

Note: Switching delimiters off really simply changes them to ASCII characters "\x00" and "\x01" which, usually should not occure in a template.

Templates can accept configuration data in YAML format which immediately follows the Include and Delims tag, if present:

<!-- Include: <path>
     <yaml-data> -->

Mark also supports attachments. The standard way involves declaring an Attachment along with the other items in the header, then have any links with the same path:

<!-- Attachment: <path-to-image> -->

<beginning of page content>

An attached link is [here](<path-to-image>)

NOTE: Be careful with Attachment! If your path string is a subset of another longer string or referenced in text, you may get undesired behavior.

Mark also supports macro definitions, which are defined as regexps which will be replaced with specified template:

<!-- Macro: <regexp>
     Template: <path>
     <yaml-data> -->

NOTE: Make sure to define your macros after your metadata (Title/Space), mark will stop processing metadata if it hits a Macro.

Capture groups can be defined in the macro's which can be later referenced in the <yaml-data> using ${<number>} syntax, where <number> is number of a capture group in regexp (${0} is used for entire regexp match), for example:

  <!-- Macro: MYJIRA-\d+
       Template: ac:jira:ticket
       Ticket: ${0} -->

Macros can also use inline templates. Inline templates are templates where the template content is described in the <yaml-data>. The Template value starts with a #, followed by the key used in the <yaml-data>. The key's value must be a string which defines the template's content.

  <!-- Macro: <tblbox\s+(.*?)\s*>
       Template: #inline
       title: ${1}
       inline: |
           <table>
           <thead><tr><th>{{ .title }}</th></tr></thead>
           <tbody><tr><td>
        -->
  <!-- Macro: </tblbox>
       Template: #also_inline
       also_inline: |
           </td></tr></tbody></table>
        -->
  <tblbox with a title>
  and some
  content
  </tblbox>

Automatic Page Title

If you don't want to specify the page title in the metadata of each file, mark provides two ways to set it automatically.

From the first H1 heading

You can use the --title-from-h1 flag to extract the page title from the first H1 heading in the markdown file. If no H1 heading is found, the title must be set in the page metadata.

From the filename

You can use the --title-from-filename flag to use the filename (without the extension) as the page title. mark will automatically convert the filename to a more readable title by:

• Replacing underscores (_) and dashes (-) with spaces.
• Applying title case to the filename.

For example, a file named my_awesome-page.md will have the title "My Awesome Page".

These two options are mutually exclusive. If both flags are provided, mark will produce an error.

Customizing the page layout

If you set the Layout to plain, the page layout can be customized using HTML comments inside the markdown:

<!-- Layout: plain -->
<!-- ac:layout -->

<!-- ac:layout-section type:three_with_sidebars -->
<!-- ac:layout-cell -->
More Content
<!-- ac:layout-cell end -->
<!-- ac:layout-cell -->
More Content
<!-- ac:layout-cell end -->
<!-- ac:layout-cell -->
Even More Content
<!-- ac:layout-cell end -->
<!-- ac:layout-section end -->

<!-- ac:layout-section type:single -->
<!-- ac:layout-cell -->
Still More Content
<!-- ac:layout-cell end -->
<!-- ac:layout-section end -->

<!-- ac:layout end -->

Please be aware that mark does not validate the layout, so it's your responsibility to create a valid layout.

Placeholders

You can use this to define placeholders:

<!-- ac:placeholder -->
Placeholder
<!-- ac:placeholder end -->

Code Blocks

```bash
...
some long bash code block
...
```

Parameter	Default
collapse	false
title	none
linenumbers	false
1 (any number for firstline)	1

Example:

• bash collapse If you have long code blocks, you can make them collapsible.
• bash collapse title Some long long bash function And you can also add a title.
• bash linenumbers collapse title Some long long bash function And linenumbers.
• bash 1 collapse title Some long long bash function Or directly give a number as firstline number.
• bash 1 collapse midnight title Some long long bash function And even themes.
• - 1 collapse midnight title Some long long code Please note that, if you want to have a code block without a language use - as the first character, if you want to have the other goodies.

More details at Confluence Code Block Macro doc.

Block Quotes

GitHub Alerts Support

You can now use GitHub-style alert syntax in your markdown, and Mark will automatically convert them to Confluence macros:

> [!NOTE]
> This creates a blue info box - perfect for helpful information!

> [!TIP]
> This creates a green tip box - great for best practices and suggestions!

> [!IMPORTANT]
> This creates a blue info box - ideal for critical information!

> [!WARNING]
> This creates a yellow warning box - use for important warnings!

> [!CAUTION]
> This creates a red warning box - perfect for dangerous situations!

Technical Details

Block Quotes are converted to Confluence Info/Warn/Note box when the following conditions are met:

1. The BlockQuote is on the root level of the document (not nested)
2. The first line of the BlockQuote contains one of the following patterns Info/Warn/Note or GitHub MD Alerts style [!NOTE]/[!TIP]/[!IMPORTANT]/[!WARNING]/[!CAUTION]

GitHub Alerts	Confluence	Description
[!TIP] (green lightbulb)	Tip (green checkmark in circle)	Helpful suggestions and best practices
[!NOTE] (blue I in circle)	Info (blue I in circle)	General information and notes
[!IMPORTANT] (purple exclamation mark in speech bubble)	Info (blue I in circle)	Critical information that needs attention
[!WARNING] (yellow exclamation mark in triangle)	Note (yellow exclamation mark in triangle)	Important warnings and cautions
[!CAUTION] (red exclamation mark in hexagon)	Warning (red exclamation mark in hexagon)	Dangerous situations requiring immediate attention

In any other case the default behaviour will be resumed and html <blockquote> tag will be used

Task Lists

Mark supports GitHub Flavored Markdown task lists. Task lists are automatically converted to Confluence ac:task-list elements.

- [x] Finished task
- [ ] Unfinished task

If a list is "mixed" (contains both tasks and regular list items), it will fall back to a standard HTML list with textual markers like [x] or [ ] to ensure validity in Confluence storage format.

Template & Macros

By default, mark provides several built-in templates and macros:

• template ac:status to include badge-like text, which accepts following parameters:

  • Title: text to display in the badge
  • Color: color to use as background/border for badge
    • Grey
    • Red
    • Yellow
    • Green
    • Blue
  • Subtle: specify to fill badge with background or not
    • true
    • false

• template ac:boxto include info, tip, note, and warning text boxes. Parameters:

  • Name: select box style
    • info
    • tip
    • note
    • warning
  • Icon: show information/tip/exclamation mark/warning icon
    • true
    • false
  • Title: title text of the box
  • Body: text to display in the box

  See: https://confluence.atlassian.com/conf59/info-tip-note-and-warning-macros-792499127.html

• template ac:jira:ticket to include JIRA ticket link. Parameters:

  • Ticket: Jira ticket number like BUGS-123.

  See: https://confluence.atlassian.com/conf59/status-macro-792499207.html

• template ac:jira:filter to include JIRA Filters/Searches. Parameters:

  • JQL: The "JQL" query of the search
  • Server (Optional): The Jira server to fetch the query from if its not the default of "System Jira"

• template ac:jiraissues to include a list of JIRA tickets. Parameters:

  • URL (Required), The URL of the XML view of your selected issues. (link to the filter)
  • Anonymous (Optional) If this parameter is set to 'true', your JIRA application will return only the issues which allow unrestricted viewing. That is, the issues which are visible to anonymous viewers. If this parameter is omitted or set to 'false', then the results depend on how your administrator has configured the communication between the JIRA application and Confluence. By default, Confluence will show only the issues which the user is authorised to view.
  • BaseURL (Optional) If you specify a 'baseurl', then the link in the header, pointing to your JIRA application, will use this base URL instead of the value of the 'url' parameter. This is useful when Confluence connects to JIRA with a different URL from the one used by other users.
  • Columns (Optional) A list of JIRA column names, separated by semi-colons (;). You can include many columns recognized by your JIRA application, including custom columns.
  • Count (Optional) If this parameter is set to 'true', the issue list will show the number of issues in JIRA. The count will be linked to your JIRA site.
  • Cache (Optional) The macro maintains a cache of the issues which result from the JIRA query. If the 'cache' parameter is set to 'off', the relevant part of the cache is cleared each time the macro is reloaded. (The value 'false' also works and has the same effect as 'off'.)
  • Height (Optional) The height in pixels of the table displaying the issues.
  • RenderMode (Optional) If the value is 'dynamic', the JIRA Issues macro offers an interactive display.
  • Title (Optional) You can customise the title text at the top of the issues table with this parameter. For instance, setting the title to 'Bugs-to-fix' will replace the default 'JIRA Issues' text. This can help provide more context to the list of issues displayed.
  • Width (Optional) The width of the table displaying the issues. Can be entered as a percentage (%) or in pixels (px).

  See: https://confluence.atlassian.com/doc/jira-issues-macro-139380.html

• template: ac:emoticon to include emoticons. Parameters:

  • Name: select emoticon
    • smile
    • sad
    • cheeky
    • laugh
    • wink
    • thumbs-up
    • thumbs-down
    • information
    • tick
    • cross
    • warning
    • plus
    • minus
    • question
    • light-on
    • light-off
    • yellow-star
    • red-star
    • green-star
    • blue-star

  See: https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html

• template: ac:youtube to include YouTube Widget. Parameters:

  • URL: YouTube video endpoint
  • Width: Width in px. Defaults to "640px"
  • Height: Height in px. Defaults to "360px"

  See: https://confluence.atlassian.com/doc/widget-connector-macro-171180449.html#WidgetConnectorMacro-YouTube

• template: ac:children to include Children Display macro

  • Reverse (Reverse Sort): Use with the Sort Children By parameter. When set, the sort order changes from ascending to descending.
    • true
    • false (Default)
  • Sort (Sort Children By):
    • creation — to sort by content creation date
    • title — to sort alphabetically on title
    • modified — to sort of last modification date.
    • If not specified, manual sorting is used if manually ordered, otherwise alphabetical.
  • Style (Heading Style): Choose the style used to display descendants.
    • from h1 to h6
    • If not specified, default style is applied.
  • Page (Parent Page):
    • / — to list the top-level pages of the current space, i.e. those without parents.
    • pagename — to list the children of the specified page.
    • spacekey:pagename — to list the children of the specified page in the specified space.
    • If not specified, the current page is used.
  • Excerpt (Include Excerpts): Allows you to include a short excerpt under each page in the list.
    • none - no excerpt will be displayed. (Default)
    • simple - displays the first line of text contained in an Excerpt macro any of the returned pages. If there is not an Excerpt macro on the page, nothing will be shown.
    • rich content - displays the contents of an Excerpt macro, or if there is not an Excerpt macro on the page, the first part of the page content, including formatted text, images and some macros.
  • First (Number of Children): Restrict the number of child pages that are displayed at the top level.
    • If not specified, no limit is applied.
  • Depth (Depth of Descendants): Enter a number to specify the depth of descendants to display. For example, if the value is 2, the macro will display 2 levels of child pages. This setting has no effect if Show Descendants is enabled.
    • If not specified, no limit is applied.
  • All (Show Descendants): Choose whether to display all the parent page's descendants.
    • true
    • false (Default)

  See: https://confluence.atlassian.com/doc/children-display-macro-139501.html

• template: ac:iframe to include iframe macro (cloud only)

  • URL: URL to the iframe.
  • Frameborder: Choose whether to draw a border around content in the iframe.
    • show (Default)
    • hide
  • Width: Width in px. Defaults to "640px"
  • Height: Height in px. Defaults to "360px"
  • Scrolling: Allow or prevent scrolling in the iframe to see additional content.
    • yes
    • no
    • auto (Default)
  • Align: Align the iframe to the left or right of the page.
    • left (Default)
    • right

  See: https://support.atlassian.com/confluence-cloud/docs/insert-the-iframe-macro

• template: ac:blog-poststo include blog-posts

  • Content: How much content will be shown
    • titles (default)
    • excerpts
    • entire
  • Time: Specify how much back in time Confluence should look for blog posts (default: unlimited)
  • Label: Restrict to blog posts with specific labels
  • Author: Restrict to blog posts by specific authors
  • Spaces: Restrict to blog posts in specific spaces
  • Max: Maximum number of blog posts shown (default: 15)
  • Sort: Sorting posts by
    • title
    • creation (default)
    • modified
  • Reverse: Reverses the Sort parameter from oldest to newest (default: false)

  See: https://confluence.atlassian.com/doc/blog-posts-macro-139470.html

• template: ac:include to include a page

  • Page: the page to be included
  • Space: the space the page is in (optional, otherwise same space)

• template: ac:excerpt-include to include the excerpt from another page

  • Page: the page the excerpt should be included from
  • Name: The specific identifier for the excerpt, allowing multiple Excerpt macros on one page to be referenced individually. If not provided, the first excerpt from the page will be used (optional, cloud only)
  • NoPanel: Determines whether Confluence will display a panel around the excerpted content (optional, default: false)

• template: ac:excerpt to create an excerpt and include it in the page

  • Excerpt: The text you want to include
  • Name: Allows you to identify this macro so that you can add multiple Excerpt macros to one page and use a specific one on another page using the Excerpt Include macro (optional, cloud only)
  • OutputType: Determines whether the content of the Excerpt macro body is displayed on a new line or inline (optional, options: "BLOCK" or "INLINE", default: BLOCK)
  • Hidden: Hide the excerpt content (optional, default: false)

• template: ac:anchor to set an anchor inside a page

  • Anchor: Text for the anchor

• template: ac:expand to display an expandable/collapsible section of text on your page

  • Title: Defines the text next to the expand/collapse icon.
  • Body: The Text that it is expanded to.

• template: ac:profile to display a short summary of a given Confluence user's profile.

  • Name: The username of the Confluence user whose profile summary you wish to show.

• template: ac:contentbylabel to display a list of pages, blog posts or attachments that have particular labels

  • CQL: The CQL query to discover the content

• template: ac:detailssummary to show summary information from one page on a another page

  • Headings: Column headings to show
  • FirstColumn: Name of the Title Column
  • CQL: The CQL query to discover the pages
  • SortBy: Sort by a specific column heading

• template: ac:details to create page properties

  • Body: Must contain a table with two rows, the table headings are used as property key. The table content is the value.

• template: ac:panel to display a block of text within a customisable panel

  • Title: Panel title (optional)
  • Body: Body text of the panel
  • BGColor: Background Color
  • TitleBGColor: Background color of the title bar
  • TitleColor: Text color of the title
  • BorderStyle: Style of the panel's border

• template ac:recently-updated to display a list of most recently changed content

  • Spaces: List of Spaces to watch (optional, default is current Space)
  • ShowProfilePic: Show profile picture of editor
  • Max: Maximum number of changes
  • Types: Include these content types only (comments, blogposts, pages)
  • Theme: Apperance of the macro (concise, social, sidebar)
  • HideHeading: Determines whether the macro hides or displays the text 'Recently Updated' as a title above the list of content
  • Labels: Filter the results by label. The macro will display only the pages etc which are tagged with the label(s) you specify here.

• template: ac:pagetreesearch to add a search box to your Confluence page.

  • Root: Name of the root page whose hierarchy of pages will be searched by this macro. If this not specified, the root page is the current page.

• template: ac:column To be used with the section macro to define the columns in a page.

  • Width: Width of the column
  • Body: The content of the column

• template: ac:multimedia to embedd an attached video, animation or other multimedia files in a Confluence page

  • Name: Name of the file
  • Width: Width of the video (optional)
  • AutoPlay: Start playing the file on page load (default: false)

• template ac:view-file

  • Name: Name of the file
  • Height: height of the view

• macro @{...} to mention user by name specified in the braces.

Template & Macros Usecases

Insert Disclaimer

This should be in disclaimer.md.

**NOTE**: this document is generated, do not edit manually.

Add this to your article.md.

<!-- Space: TEST -->
<!-- Title: My Article -->

<!-- Include: disclaimer.md -->

This is my article.

Insert Status Badge

<!-- Space: TEST -->
<!-- Title: TODO List -->

<!-- Macro: :done:
     Template: ac:status
     Title: DONE
     Color: Green -->

<!-- Macro: :todo:
     Template: ac:status
     Title: TODO
     Color: Blue -->

* :done: Write Article
* :todo: Publish Article

Insert Colored Text Box

<!-- Space: TEST -->
<!-- Title: Announcement -->

<!-- Macro: :box:([^:]+):([^:]*):(.+):
     Template: ac:box
     Icon: true
     Name: ${1}
     Title: ${2}
     Body: ${3} -->

:box:info::Foobar:
:box:tip:Tip of day:Foobar:
:box:note::Foobar:
:box:warning:Alert!:Foobar:

Insert Table of Contents

<!-- Include: ac:toc -->

If default TOC looks don't find a way to your heart, try parametrizing it, for example:

<!-- Macro: :toc:
     Template: ac:toc
     Printable: 'false'
     MinLevel: 2 -->

# This is my nice title

:toc:

You can call the Macro as you like but the Template field must have the ac:toc value. Also, note the single quotes around 'false'.

See Confluence TOC Macro for the list of parameters - keep in mind that here they start with capital letters. Every skipped field will have the default value, so feel free to include only the ones that you require.

Insert PageTree

# My First Heading
<!-- Include: ac:pagetree -->

The pagetree macro works almost the same as the TOC above, but the tree behavior is more desirable for creating placeholder pages above collections of SOPs.

The default pagetree macro behavior is to insert a tree rooted @self.

The following parameters can be used to alter your default configuration with parameters described more in depth here:Confluence Pagetree Macro.

Parameters:

• Title (of tree root page)
• Sort
• Excerpt
• Reverse
• SearchBox
• ExpandCollapseAll
• StartDepth

E.G.

<!-- Macro: :pagetree:
     Template: ac:pagetree
     Reverse: 'true'
     ExpandCollapseAll: 'true'
     StartDepth: 2 -->

# My First Heading

:pagetree:

Insert Children Display

To include Children Display (TOC displaying children pages) use following macro:

<!-- Macro: :children:
     Template: ac:children
-->

# This is my nicer title

:children:

You can use various parameters to modify Children Display:

<!-- Macro: :children:
     Template: ac:children
     Sort: title
     Style: h3
     Excerpt: simple
     First: 10
     Page: Space:Page title
     Depth: 2
     Reverse: false
     All: false -->

# This is my nicest title

:children:

Insert Jira Ticket

<!-- Space: TEST -->
<!-- Title: TODO List -->

<!-- Macro: MYJIRA-\d+
     Template: ac:jira:ticket
     Ticket: ${0} -->

See task MYJIRA-123.

Insert link to existing confluence page by title

This is a [link to an existing confluence page](ac:Pagetitle)

And this is how to link when the linktext is the same as the [Pagetitle](ac:)

Link to a [page title containing spaces](<ac:With Multiple Words>)

Upload and included inline images

![Example](../images/examples.png)

will automatically upload the inlined image as an attachment and inline the image using the ac:image template.

If the file is not found, it will inline the image using the ac:image template and link to the image.

Add width for an image

Use the following macro:

<!-- Macro: \!\[.*\]\((.+)\)\<\!\-\- width=(.*) \-\-\>
     Template: ac:image
     Attachment: ${1}
     Width: ${2} -->

And attach any image with the following

![Example](../images/example.png)<!-- width=300 -->

The width will be the commented html after the image (in this case 300px).

Currently this is not compatible with the automated upload of inline images.

Render Mermaid Diagram

Confluence doesn't provide mermaid.js support natively. Mark provides a convenient way to enable the feature like GitHub does. As long as you have a code block marked as "mermaid", mark will automatically render it as a PNG image and attach it to the page as a rendered version of the code block.

graph TD;
A-->B;

Render D2 Diagram

Optionally you can enable D2 rendering via --features="d2". This will transform the d2 diagram into a png that will be attached to Confluence, similar to how mermaid-go support works. All you need is a codeblock marked as "d2".

X -> Y

MkDocs' Admonitions

Optionally you can enable mkdocs-style Admonitions via --features="mkdocsadmonitions".

When enabled, this renders note, warning, tip, info admonitions as Confluence alerts.

!!! note

Installation

Homebrew

brew tap kovetskiy/mark
brew install mark

Go Install

go install github.com/kovetskiy/mark/v16/cmd/mark@latest

Releases

Download a release from the Releases page

Docker

docker run --rm -i kovetskiy/mark:latest mark <params>

Compile and install using docker-compose

Mostly useful when you intend to enhance mark.

# Create the binary
$ docker-compose run markbuilder
# "install" the binary
$ cp mark /usr/local/bin

Usage

NAME:
   mark - A tool for updating Atlassian Confluence pages from markdown.

USAGE:
   mark [global options]

VERSION:
   v16.x.x

DESCRIPTION:
   Mark is a tool to update Atlassian Confluence pages from markdown. Documentation is available here: https://github.com/kovetskiy/mark

GLOBAL OPTIONS:
   --files string, -f string                use specified markdown file(s) for converting to html. Supports file globbing patterns (needs to be quoted). [$MARK_FILES]
   --continue-on-error                      don't exit if an error occurs while processing a file, continue processing remaining files. [$MARK_CONTINUE_ON_ERROR]
   --compile-only                           show resulting HTML and don't update Confluence page content. [$MARK_COMPILE_ONLY]
   --dry-run                                resolve page and ancestry, show resulting HTML and exit. [$MARK_DRY_RUN]
   --edit-lock, -k                          lock page editing to current user only to prevent accidental manual edits over Confluence Web UI. [$MARK_EDIT_LOCK]
   --drop-h1                                don't include the first H1 heading in Confluence output. [$MARK_DROP_H1]
   --strip-linebreaks, -L                   remove linebreaks inside of tags, to accommodate non-standard Confluence behavior [$MARK_STRIP_LINEBREAKS]
   --title-from-h1                          extract page title from a leading H1 heading. If no H1 heading on a page exists, then title must be set in the page metadata. Mutually exclusive with --title-from-filename. [$MARK_TITLE_FROM_H1]
   --title-from-filename                    use the filename (without extension) as the Confluence page title if no explicit page title is set in the metadata. Mutually exclusive with --title-from-h1. [$MARK_TITLE_FROM_FILENAME]
   --title-append-generated-hash            appends a short hash generated from the path of the page (space, parents, and title) to the title [$MARK_TITLE_APPEND_GENERATED_HASH]
   --minor-edit                             don't send notifications while updating Confluence page. [$MARK_MINOR_EDIT]
   --version-message string                 add a message to the page version, to explain the edit (default: "") [$MARK_VERSION_MESSAGE]
   --color string                           display logs in color. Possible values: auto, never. (default: "auto") [$MARK_COLOR]
   --log-level string                       set the log level. Possible values: TRACE, DEBUG, INFO, WARNING, ERROR, FATAL. (default: "info") [$MARK_LOG_LEVEL]
   --username string, -u string             use specified username for updating Confluence page. [$MARK_USERNAME]
   --password string, -p string             use specified token for updating Confluence page. Specify - as password to read password from stdin, or your Personal access token. Username is not mandatory if personal access token is provided. For more info please see: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/#authentication. [$MARK_PASSWORD]
   --target-url string, -l string           edit specified Confluence page. If -l is not specified, file should contain metadata (see above). [$MARK_TARGET_URL]
   --base-url string, -b string             base URL for Confluence. Alternative option for base_url config field. [$MARK_BASE_URL]
   --config string, -c string               use the specified configuration file. (default: "${HOME}/.config/mark.toml") [$MARK_CONFIG]
   --ci                                     run on CI mode. It won't fail if files are not found. [$MARK_CI]
   --space string                           use specified space key. If the space key is not specified, it must be set in the page metadata. [$MARK_SPACE]
   --parents string                         A list containing the parents of the document separated by parents-delimiter (default: '/'). These will be prepended to the ones defined in the document itself. [$MARK_PARENTS]
   --parents-delimiter string               The delimiter used for the parents list (default: "/") [$MARK_PARENTS_DELIMITER]
   --content-appearance string              default content appearance for pages without a Content-Appearance header. Possible values: full-width, fixed. [$MARK_CONTENT_APPEARANCE]
   --mermaid-scale float                    defines the scaling factor for mermaid renderings. (default: 1) [$MARK_MERMAID_SCALE]
   --include-path string                    Path for shared includes, used as a fallback if the include doesn't exist in the current directory. [$MARK_INCLUDE_PATH]
   --changes-only                           Avoids re-uploading pages that haven't changed since the last run. [$MARK_CHANGES_ONLY]
   --preserve-comments                      Fetch and preserve inline comments on existing Confluence pages. [$MARK_PRESERVE_COMMENTS]
   --d2-scale float                         defines the scaling factor for d2 renderings. (default: 1) [$MARK_D2_SCALE]
   --features string [ --features string ]  Enables optional features. Current features: d2, mermaid, mention, mkdocsadmonitions (default: "mermaid", "mention") [$MARK_FEATURES]
   --insecure-skip-tls-verify               skip TLS certificate verification (useful for self-signed certificates) [$MARK_INSECURE_SKIP_TLS_VERIFY]
   --image-align string                     set image alignment (left, center, right). Can be overridden per-file via the Image-Align header. [$MARK_IMAGE_ALIGN]
   --help, -h                               show help
   --version, -v                            print the version

You can store user credentials in the configuration file, which should be located in a system specific directory (or specified via -c --config <path>) with the following format (TOML):

username = "your-email"
password = "password-or-api-key-for-confluence-cloud"
# If you are using Confluence Cloud add the /wiki suffix to base_url
base-url = "http://confluence.local"
title-from-h1 = true
drop-h1 = true
image-align = "center"

NOTE: Labels aren't supported when using minor-edit!

NOTE: See Preserving Inline Comments for a detailed description of the --preserve-comments flag.

NOTE: The system specific locations are described in here: https://pkg.go.dev/os#UserConfigDir. Currently, these are: On Unix systems, it returns $XDG_CONFIG_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.config. On Darwin, it returns $HOME/Library/Application Support. On Windows, it returns %AppData%. On Plan 9, it returns $home/lib.

Tricks

Continuous Integration

It's quite trivial to integrate Mark into a CI/CD system, here is an example with Snake CI in case of self-hosted Bitbucket Server / Data Center.

stages:
  - sync

Sync documentation:
  stage: sync
  only:
    branches:
      - main
  image: kovetskiy/mark
  commands:
    - for file in $(find -type f -name '*.md'); do
        echo "> Sync $file";
        mark -u $MARK_USER -p $MARK_PASS -b $MARK_URL -f $file || exit 1;
        echo;
      done

In this example, I'm using the kovetskiy/mark image for creating a job container where the repository with documentation will be cloned to. The following command finds all *.md files and runs mark against them one by one:

for file in $(find -type f -name '*.md'); do
    echo "> Sync $file";
    mark -u $MARK_USER -p $MARK_PASS -b $MARK_URL -f $file || exit 1;
    echo;
done

The following directive tells the CI to run this particular job only if the changes are pushed into the main branch. It means you can safely push your changes into feature branches without being afraid that they have automatically shown in Confluence, then go through the reviewal process and automatically deploy them when PR got merged.

only:
  branches:
    - main

File Globbing

Rather than running mark multiple times, or looping through a list of files from find, you can use file globbing (i.e. wildcard patterns) to match files in subdirectories. For example:

mark -f "helpful_cmds/*.md"

You can also use ** to get all files recursively.

mark -f "**/docs/*.md"

Linting markdown

We recommend to lint your markdown files with markdownlint-cli2 before publishing them to confluence to catch any conversion errors early.

Preserving Inline Comments

When collaborators leave inline comments on a Confluence page, updating the page via mark will normally erase those comments because the stored body is fully replaced. The --preserve-comments flag re-attaches inline comment markers to the new page body before uploading, so existing review threads survive updates.

mark --preserve-comments -f docs/page.md

Or via environment variable:

MARK_PRESERVE_COMMENTS=true mark -f docs/page.md

How it works:

1. Before uploading, mark fetches the current page body and all inline comment markers from the Confluence API.
2. For each existing <ac:inline-comment-marker> tag it records the content wrapped by that marker plus a short context window immediately before the opening tag and immediately after the closing tag in the old body (not around the raw selection text, so the context is stable even when the marker wraps additional inline markup such as <strong>).
3. It searches the new body for the same selected text and picks the occurrence whose surrounding context best matches the original (using Levenshtein distance), so the marker lands in the right place even if nearby text has shifted.
4. The updated body—with all markers re-embedded—is then uploaded as normal.

Limitations:

• If the commented text was deleted from the document, the inline comment cannot be relocated and will be lost. mark logs a warning in this case.
• Overlapping selections (two comments anchored to the same stretch of text) are detected; the earlier overlapping match is dropped with a warning, and the later one (higher byte offset) is kept, rather than producing malformed markup.
• --preserve-comments is automatically skipped for newly created pages (there are no comments to preserve yet).
• When combined with --changes-only, the comment-preservation API calls are skipped entirely on runs where the page content has not changed, avoiding unnecessary round-trips.

Issues, Bugs & Contributions

I've started the project to solve my own problem and open sourced the solution so anyone who has a problem like me can solve it too. I have no profits/sponsors from these projects which means I don't really prioritize working on this project in my free time. I still check the issues and do code reviews for Pull Requests which means if you encounter a bug in the program, you should not expect me to fix it as soon as possible, but I'll be very glad to merge your own contributions into the project and release the new version.

I try to label all new issues, so it's easy to find a bug or a feature request to fix/implement, if you are willing to help with the project, you can use the following labels to find issues, just make sure to reply in the issue to let everyone know you took the issue:

• label:feature-request
• label:bug

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Manuel Rüger 🚧 💻	Egor Kovetskiy 🚧 💻	Nick Klauer 💻	Rolf Ahrenberg 💻	Charles Southerland 💻	Šarūnas Nejus 💻	Alexey Baranov 💻
Anthony Barbieri 💻	Devin Auclair 💻	Gezim Sejdiu 💻	Josip Ćavar 💻	Juho Saarinen 💻	Luke Fritz 💻	Matt Radford 💻
Planktonette 💻	Stefano Teodorani 💻	Tim Schrumpf 💻	Tyler Cole 💻	elgreco247 💻	emead-indeed 💻	Will Hegedus 💻
Leandro Carneiro 💻	beeme1mr 💻	Taldrain 💻	Hugo Cisneiros 💻	jevfok 💻	Mateus Miranda 💻	Stephan Hradek 💻
Dreampuf 💻	Joel Andritsch 💻	guoweis-outreach 💻	klysunkin 💻	Florent Monbillard 💻	Joey Freeland 💻	Noam Asor 💻
Philipp 💻	Pommier Vincent 💻	Toru Kawaguchi 💻	Will Gorman 💻	Zackery Griesinger 💻	cc-chris 💻	datsickkunt 💻
recrtl 💻	Stanislav Seletskiy 💻	Joris Conijn 💻

This project follows the all-contributors specification. Contributions of any kind welcome!