md2jira-cli
v1.0.0
Published
CLI to convert Markdown to Jira Wiki Markup, Atlassian Document Format (ADF), or Confluence Storage Format
Maintainers
Readme
md2jira-cli
Convert Markdown to Jira Wiki Markup from the command line.
Install
# Global install
npm install -g md2jira-cli
# No install needed
npx md2jira-cli input.mdUsage
File to stdout
md2jira input.mdFile to file
md2jira input.md -o output.txtPipe from stdin
# macOS / Linux
cat input.md | md2jira
# Windows (PowerShell)
Get-Content input.md | md2jiraExample
Given ticket.md:
# Bug: login fails on Safari
**Steps to reproduce:**
1. Open Safari
2. Go to `/login`
3. Submit the form
`console.error` shows a CORS error.
| Browser | Status |
| ------- | -------- |
| Chrome | ✅ Works |
| Safari | ❌ Fails |Running md2jira ticket.md outputs:
h1. Bug: login fails on Safari
*Steps to reproduce:*
# Open Safari
# Go to /login
# Submit the form
{{console.error}} shows a CORS error.
|| Browser || Status ||
| Chrome | ✅ Works |
| Safari | ❌ Fails |Options
| Argument / Option | Description |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
| [input] | Input Markdown file. Omit to read from stdin. |
| -o, --output <file> | Write output to a file instead of stdout. |
| -f, --format <format> | Output format: wiki (default), adf (Atlassian Document Format JSON), or confluence (Confluence Storage Format XHTML). |
| --base-url <url> | Absolute base URL prepended to relative links (e.g. https://company.atlassian.net/wiki). |
| --disable <transforms> | Suppress one or more transforms. Comma-separated or repeat the flag. See values below. |
| -V, --version | Print version number. |
| -h, --help | Display help. |
--disable values
heading · list · code · blockquote · table · thematicBreak · panel
Examples
Output ADF JSON:
md2jira input.md --format adf
cat input.md | md2jira -f adf > output.jsonOutput Confluence Storage Format:
md2jira input.md --format confluence
cat input.md | md2jira -f confluence > output.xmlResolve relative links against a Confluence base URL:
md2jira input.md --base-url https://company.atlassian.net/wikiSuppress heading and list transforms:
# Comma-separated
md2jira input.md --disable heading,list
# Repeated flag
md2jira input.md --disable heading --disable listCombine options:
md2jira input.md \
--base-url https://company.atlassian.net/wiki \
--disable panel \
--format adf \
-o output.jsonRelated
- md2jira-core — the underlying conversion library (use in Node.js / Deno / Bun)
- Live Demo — browser app
Support the Project
If you find this tool useful, consider buying me a coffee :)
License
MIT
