Giter Club home page Giter Club logo

md2cf's Introduction

confluence-url

md2cf

Push markdown files straight to a Confluence page.

What it does?

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

How to use it?

Markdown to Confluence

Example workflow:

1. Create a new page under --parent_id:

  $ ./md2cf.py --user [email protected] --token 9a8dsadsh --url https://your-domain.atlassian.net \
          create --file README.md --parent_id 182371 --title "new title" --add_meta

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

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

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

  $ ./md2cf.py --user [email protected] --token 9a8dsadsh update --file README.md

Doing an update with --page_id and --url is still possible.

Consider adding useful --add_info option.

To create Atlassian API Token go to api-tokens.

Actions:

  • update Updates page content based on given page_id or metadata in Markdown file
  • create Creates new page under given parent_id

positional arguments:

  • {update,create} Action to run

optional arguments:

  • -h, --help show this help message and exit
  • --file FILE input markdown file to process
  • --add_meta adds metadata to .md file for easy editing
  • --add_info adds info panel automatic content do not edit on top of the page
  • --add_label ADD_LABEL adds label to page
  • -v, --verbose verbose mode

required auth parameters:

  • -u USER, --user USER Atlassian username/email
  • -t TOKEN, --token TOKEN Atlassian API token
  • -l URL, --url URL Atlassian instance URL

create page parameters:

  • --parent_id PARENT_ID define parent page id while creating a new page
  • --title TITLE define page title while creating a new page

update page arguments:

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

md2cf's People

Contributors

szn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.