2 个版本

0.1.1 2020 年 9 月 24 日
0.1.0 2020 年 9 月 23 日

#7#commonmark

自定义许可

23KB
586

将 Markdown 转换为 Jira 使用的标记格式

Jira 使用的标记语言并不常见。相比之下,Markdown 得到广泛使用,并且许多编辑器都支持编辑它。我喜欢将我的文档保存在 Markdown 格式,但当我需要将其粘贴到 Jira 表单中时,这并不很好用。这就是这个小巧的命令行工具发挥作用的地方。它使用优秀的 pulldown-cmark 库来读取来自 stdin 或文件的 CommonMark 版本的 Markdown,并将其转换为 Jira 使用的格式,既可以输出到 stdout,也可以输出到文件。

安装

首先,您需要一个正常的 rustc + cargo 安装。这可以通过安装您发行版中可用的包,或者通过 https://rustup.rs/ 实现。然后,您可以通过运行以下命令来安装 md2jiracargo install -f md2jira-f 标志强制覆盖以前的版本。

示例用法

user@host:~/Projects/md2jira$ cat example.md
# Markdown and Jira

I typically write notes in [Markdown](https://daringfireball.net/projects/markdown/).

---

## md2jira can convert:

* Lists
    1. Nested
    2. Ordered
    3. Unordered
* Tables
* Headings
* *Strong*
* **Emphasis**
* ~~Strikethrough~~
* Horizontal rules
* etc…
user@host:~/Projects/md2jira$ md2jira -i example.md
h1. Markdown and Jira

I typically write notes in [Markdown|https://daringfireball.net/projects/markdown/].

----

h2. md2jira can convert:

* Lists
*# Nested
*# Ordered
*# Unordered
* Tables
* Headings
* _Strong_
* *Emphasis*
* -Strikethrough-
* Horizontal rules
* etc…
user@host:~/Projects/md2jira$ 

替代方案

  • pandoc 可以转换多种格式,并且还支持多种 Markdown 版本以及 Jira 标记格式。根据我使用 pandoc 的经验,他们对这两种格式的支持可能优于我在 md2jira 中实现的。转换双向支持加分。可以使用以下命令进行转换:
    pandoc --from commonmark --to jira example.md
    

依赖项

~4MB
~73K SLoC