Markdown to JIRA and Confluence Markup Syntax Converter

Simple Python utilities for converting from Github-flavored Markdown syntax to Atlassian's custom markup syntax, and vice-versa. Useful for code maintainers and doc writers who use GitHub, JIRA, and Confluence.

Introduction

This is a simple Python utility to convert Markdown to JIRA and Confluence markup syntax. It is written in Python, and is designed to be used as a command line tool.

It has been purposely designed to be fully self-contained, requiring no external libraries or dependencies.

It is also designed to be easily extensible, so that it can be easily modified to support additional Markdown syntax.

Requirements

Requires Python 3.6 or later.
Tested on MacOS, Linux, and Windows.

Installation

Clone this repository. There are no external dependencies, so no pip installation is required, and no virtual environment is needed.

It's recommended to add this script to your PATH environment variable, so that it can be run from anywhere.

You could alternatively add it to a ~/scripts/ directory and create a md_to_jira alias for it by adding the following line to your ~/.bashrc, ~/.zshrc, or ~/.profile file:

alias md_to_jira="python3 ~/scripts/md_to_jira.py"
alias jira_to_md="python3 ~/scripts/jira_to_md.py"

It can also be run directly from the cloned repository directory, but this is not recommended.

Usage and Examples

Below are usage instructions with some simple examples. For each item, the usage syntax is first, followed by an example for illustration purposes.

Converting from Markdown to JIRA/Confluence Markup Syntax

# Convert a markdown file to Jira/Confluence markup and print to stdout
python3 md_to_jira.py <markdown_file>
python3 md_to_jira.py README.md

# Convert a markdown file to Jira/Confluence markup and save to a file
python3 md_to_jira.py <markdown_file> > <jira_file>
python3 md_to_jira.py README.md > README.jira

# Convert a markdown file to Jira/Confluence markup and copy to clipboard (MacOS)
python3 md_to_jira.py <markdown_file> | pbcopy
python3 md_to_jira.py README.md | pbcopy

# Convert a markdown file to Jira/Confluence markup and copy to clipboard (Linux)
python3 md_to_jira.py <markdown_file | xclip -selection clipboard
python3 md_to_jira.py README.md | xclip -selection clipboard

# Convert a markdown file to Jira/Confluence markup and copy to clipboard (Windows)
python3 md_to_jira.py <markdown_file | clip
python3 md_to_jira.py README.md | clip

Converting from JIRA/Confluence Markup Syntax to Markdown

# Convert a Jira/Confluence markup file to markdown and print to stdout
python3 jira_to_md.py <jira_file>
python3 jira_to_md.py README.jira

# Convert a Jira/Confluence markup file to markdown and save to a file
python3 jira_to_md.py <jira_file> > <markdown_file>
python3 jira_to_md.py README.jira > README.md

# Convert a Jira/Confluence markup file to markdown and copy to clipboard (MacOS)
python3 jira_to_md.py <jira_file> | pbcopy
python3 jira_to_md.py README.jira | pbcopy

# Convert a Jira/Confluence markup file to markdown and copy to clipboard (Linux)
python3 jira_to_md.py <jira_file | xclip -selection clipboard
python3 jira_to_md.py README.jira | xclip -selection clipboard

# Convert a Jira/Confluence markup file to markdown and copy to clipboard (Windows)
python3 jira_to_md.py <jira_file | clip
python3 jira_to_md.py README.jira | clip

Features (implemented and planned)

Current Features

[x] Add support for headers 1-6
[x] Add support for fenced code blocks
- [x] Do not convert headers in fenced code blocks
[x] Add support for indented code blocks
- [x] Do not convert headers in indented code blocks
[x] Add support for inline code (backticks) - should be converted to JIRA's monospace syntax
[x] Add support for bold text
[x] Add support for italic text
[x] Add support for strikethrough text
[x] Add support for unordered lists
[x] Add support for in-line style links
[x] Add support for task lists
- Note: Added, but this is not supported by JIRA native markup and requires a JIRA plugin to work
[x] Add jira_to_md.py to convert JIRA/Confluence markup to GitHub-flavored Markdown (GFM)

Feature Roadmap

[ ] Add support for tables
[ ] Add support for horizontal rules
[ ] Add support for ordered lists
[ ] Add support for blockquotes
[ ] Add support for images
[ ] Add support for emojis
[ ] Add support for in-line style links with titles (if possible)
[ ] Add support for reference style links
[ ] Add support for inline HTML
[ ] Add unit tests
- [ ] Add unit tests for md_to_jira.py
- [x] Add unit tests for jira_to_md.py
[ ] Maybe: Add argparse support for command line options
[ ] Other TBD

Housekeeping action items

[ ] Add GitHub Actions config to run unit tests, flake8 linting, and other checks
[ ] Refactor and clean up code once all basic features are implemented
[ ] Enforce branch protection rules after setting up GitHub Actions and adding unit tests
- [ ] Require status checks to pass before merging
- [ ] Require pull requests to be reviewed and approved before merging
- [ ] Require branches to be up to date before merging
- [ ] Add git tags for releases

Why did I start this mini-project?

This project was created as a way to avoid having to use Atlassian's custom markup syntax.

I wanted to be able to write Confluence documentation and JIRA updates using Github-flavored Markdown, and then have a simple way to convert it without having to use an online converter, browser extension, or any third-party libraries or dependencies.

eshack94 / md-to-jira

readme