概述

jira2markdown是一个使用解析表达式语法从JIRA 标记到YouTrack Markdown的文本转换器。YouTrack 中的 Markdown 实现遵循带有扩展的CommonMark 规范。因此，jira2markdown可以用最少的修改将文本转换为任何 Markdown 语法。

目录

• 先决条件
• 安装
• 用法
• 换算表
  • 标题
  • 文字效果
  • 文本中断
  • 链接
  • 列表
  • 图片
  • 表
  • 高级格式化
• 定制

先决条件

• Python 3.6+

安装

pip install jira2markdown

用法

from jira2markdown import convert

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

# 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

换算表

标题

文字效果

文本中断

链接

列表

* some
* bullet
** indented
** bullets
* points

- some
- bullet
  - indented
  - bullets
- points

# a
# numbered
# list

1. a
1. numbered
1. list

# a
# numbered
#* with
#* nested
#* bullet
# list

1. a
1. numbered
   - with
   - nested
   - bullet
1. list

* a
* bulleted
*# with
*# nested
*# numbered
* list

- a
- bulleted
  1. with
  1. nested
  1. numbered
- list

图片

!image.jpg!
!image.jpg|thumbnail!
!image.gif|align=right, vspace=4!

![image.jpg](image.jpg)

表

||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|

|heading 1|heading 2|heading 3|
|-|-|-|
|col A1|col A2|col A3|
|col B1|col B2|col B3|

高级格式化

{noformat}
preformatted piece of text
 so *no* further _formatting_ is done here
{noformat}

```
preformatted piece of text
 so *no* further _formatting_ is done here
```

{panel:title=My Title}
Some text with a title
{panel}

> **My Title**
> Some text with a title

{code:xml}
    <test>
        <another tag="attribute"/>
    </test>
{code}

```xml
    <test>
        <another tag="attribute"/>
    </test>
```

定制

要自定义标记元素列表，请将其作为可选参数发送到convert：

from jira2markdown import convert
from jira2markdown.elements import MarkupElements
from jira2markdown.markup.links import Link
from jira2markdown.markup.text_effects import Bold

# Only bold and link tokens will be converted here
elements = MarkupElements([Link, Bold])
convert("Some Jira text here", elements=elements)

请记住，标记元素的顺序很重要！元素首先在列表中从上到下匹配。

要覆盖默认元素列表中的某些元素，请使用insert_after/replace方法：

from jira2markdown import convert
from jira2markdown.elements import MarkupElements
from jira2markdown.markup.base import AbstractMarkup
from jira2markdown.markup.links import Link
from jira2markdown.markup.text_effects import Color

class CustomColor(Color):
    ...

class MyElement(AbstractMarkup):
    ...

elements = MarkupElements()
elements.replace(Color, CustomColor)
elements.insert_after(Link, MyElement)
convert("Some Jira text here", elements=elements)