https://github.com/stevenacoffman/j2m
Convert from JIRA text formatting to GitHub Flavored MarkDown
https://github.com/stevenacoffman/j2m
github-markdown go jira jira-markdown
Last synced: about 1 year ago
JSON representation
Convert from JIRA text formatting to GitHub Flavored MarkDown
- Host: GitHub
- URL: https://github.com/stevenacoffman/j2m
- Owner: StevenACoffman
- License: mit
- Created: 2019-08-24T20:03:23.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-29T13:17:09.000Z (over 3 years ago)
- Last Synced: 2025-04-10T16:23:17.748Z (about 1 year ago)
- Topics: github-markdown, go, jira, jira-markdown
- Language: Go
- Size: 11.7 KB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://godoc.org/github.com/StevenACoffman/j2m)
[](https://goreportcard.com/report/github.com/StevenACoffman/j2m)
# jira-to-md
## JIRA to MarkDown text format converter
Golang tool to convert from JIRA Markdown text formatting to GitHub Flavored MarkDown.
## Credits
This fun toy was heavily inspired by the J2M project by Fokke Zandbergen (http://j2m.fokkezb.nl/). Major credit to Fokke, kylefarris (and other contributors) for establishing the RexExp patterns for this to work. The maintained JavaScript fork I based this on is [here](https://github.com/kylefarris/J2M)
## Supported Conversions
* Headers (H1-H6)
* Bold
* Italic
* Bold + Italic
* Un-ordered lists
* Ordered lists
* Programming Language-specific code blocks (with help from herbert-venancio)
* Inline preformatted text spans
* Un-named links
* Named links
* Monospaced Text
* ~~Citations~~ (currently kinda buggy)
* Strikethroughs
* Inserts
* Superscripts
* Subscripts
* Single-paragraph blockquotes
* Tables
* Panels
## How to Use
### Markdown String
```
**Some bold things**
*Some italic stuff*
## H2
```
### Atlassian Wiki MarkUp Syntax (JIRA)
We'll refer to this as the `jira` variable in the examples below.
```
*Some bold things**
_Some italic stuff_
h2. H2
[http://google.com]
```
### Examples
```
cat j2m.jira | j2m
```