markdown2confluence

Sync your markdown documentation with Atlassian Confluence pages

:toc:

Description

Sync markdown docs to Confluence using mark

Inputs

name	description	required	default
username	The username used to authenticate with Confluence	false	""
password	The token to be used to authenticate with Confluence	true	""
docs-path	Folder containing markdown files	false	.
exclude-dir	Exclude the markdown files inside this path	false	""
changed-only	Sync only changed markdown files	false	false
dry-run	If true this will not push any chnages, but to log the change it would have made	false	false
confluence-url	The destination Confluence url	true	""
space	Specific Confluence space to pushlish to	false	""
parent	Specific Confluence parent to pushlish to	false	""
drop-h1	Don't include the first H1 heading in Confluence output	false	false
strip-linebreaks	Remove linebreaks inside of tags, to accommodate non-standard Confluence behavior	false	false
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	false	false
title-from-filename	Use the filename (without extension) as the Confluence page title if no explicit page title is set in the metadata	false	false

Runs

This action is a docker action.

Usage

- uses: devwithkrishna/markdown2confluence@latest
  with:
    username:
    # The username used to authenticate with Confluence
    #
    # Required: false
    # Default: ""

    password:
    # The token to be used to authenticate with Confluence
    #
    # Required: true
    # Default: ""

    docs-path:
    # Folder containing markdown files
    #
    # Required: false
    # Default: .

    exclude-dir:
    # Exclude the markdown files inside this path
    #
    # Required: false
    # Default: ""

    changed-only:
    # Sync only changed markdown files
    #
    # Required: false
    # Default: false

    dry-run:
    # If true this will not push any chnages, but to log the change it would have made
    #
    # Required: false
    # Default: false

    confluence-url:
    # The destination Confluence url
    #
    # Required: true
    # Default: ""

    space:
    # Specific Confluence space to pushlish to
    #
    # Required: false
    # Default: ""

    parent:
    # Specific Confluence parent to pushlish to
    #
    # Required: false
    # Default: ""

    drop-h1:
    # Don't include the first H1 heading in Confluence output
    #
    # Required: false
    # Default: false

    strip-linebreaks:
    # Remove linebreaks inside of tags, to accommodate non-standard Confluence behavior
    #
    # Required: false
    # Default: false

    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
    #
    # Required: false
    # Default: false

    title-from-filename:
    # Use the filename (without extension) as the Confluence page title if no explicit page title is set in the metadata
    #
    # Required: false
    # Default: false