Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

confluence.md allows you to push any markdown file to Confluence. You can create a new page (under given parent) or update an existing one.

\uD83D\uDCD8 Instructions

Example workflow:

1. Create page

Create a new page under --parent_id:

Code Block
languagebash
$ confluence.md --user user@name.net \             # Atlassian username
        --token 9a8dsadsh \                        # API token or --password
        --url https://your-domain.atlassian.net \  # Confluence instance URL
        create \                                   # create or update
        --file README.md \                         # markdown file
        --parent_id 182371 \                       # parent page
        --title "new title"                        # title for a new page
        --add_meta                                 # adds meta to source.md file

2. Verify markdown

The page is created and the file is decorated with metadata:

Code Block
languagebash
$ head -n 3 markdown.md
---
confluence-url: https://your-domain.atlassian.net/wiki/spaces/SP/pages/18237182/new+title
---

3. Update page

Performing an update does not require providing --page_id and --url:

...

To create Atlassian API Token go to api-tokens.

Command line arguments

Actions:

  • update Updates page content based on given page_id or metadata in Markdown file

  • create Creates new page under given parent_id

...

  • --page_id PAGE_ID define (or override) page id while updating a page