Skip to main content

Convert text from JIRA markup to Markdown using parsing expression grammars

Project description


jira2markdown is a text converter from JIRA markup to YouTrack Markdown using parsing expression grammars. The Markdown implementation in YouTrack follows the CommonMark specification with extensions. Thus, jira2markdown can be used to convert text to any Markdown syntax with minimal modifications.


  • Python 3.6+


pip install jira2markdown


from jira2markdown import convert

convert("Some *Jira text* formatting [example|].")
# >>> Some **Jira text** formatting [example](

# To convert user mentions provide a mapping Jira internal account id to username 
# as a second argument to convert function
convert("[Winston Smith|~accountid:internal-id] woke up with the word 'Shakespeare' on his lips", {
    "internal-id": "winston",
# >>> @winston woke up with the word 'Shakespeare' on his lips

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jira2markdown-0.1.0.tar.gz (6.1 kB view hashes)

Uploaded source

Built Distribution

jira2markdown-0.1.0-py3-none-any.whl (8.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page