Code Monkey home page Code Monkey logo

mistune_jira's Introduction

mistune-jira

A Jira Rendering Engine for Mistune.

Mistune is awesome. It does an amazing job of parsing markdown. It has the ability to take those documents and export them in different sytaxes. This is an attempt to write a parser for Atlassian's Markup Language used in Jira and some other tools.

The goal is to be able to have data in markdown and then use that markdown to create a well formatted ticket in Jira.

Hopefully Jira will someday fully support markdown and make this project irrelevant.

Usage

import mistune
import mistune_jira

text = '''
# Lorem Ipsum

This is some sample markdown. [Say hi to google](https://www.google.com) as an example link
to be converted. 

HR line 
---

* a list of cool things
* doggies
    * Little Doggies (Won't yet render correctly)
    * Shaggy Doggies
    * Grumpy Doggies
* spaceships
* $2 bills

'''

rend = mistune_jira.JiraRenderer()

markdown_parser = mistune.Markdown(renderer=rend)

jira_compat = markdown_parser(text)

print(jira_compat)

mistune_jira's People

Contributors

chalbersma avatar

Watchers

 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.