https://github.com/mrmarble/marked-jira

Marked plugin to transform markdown into Jira format
https://github.com/mrmarble/marked-jira

atlassian-jira extension jira markdown marked markedjs plugin

Last synced: 4 months ago
JSON representation

Marked plugin to transform markdown into Jira format

• Host: GitHub
• URL: https://github.com/mrmarble/marked-jira
• Owner: MrMarble
• License: mit
• Created: 2025-01-12T10:21:52.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-01-27T07:33:22.000Z (4 months ago)
• Last Synced: 2025-01-29T06:51:52.792Z (4 months ago)
• Topics: atlassian-jira, extension, jira, markdown, marked, markedjs, plugin
• Language: TypeScript
• Homepage: http://mrmarble.dev/marked-jira/
• Size: 453 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# marked-jira

[![npm](https://badgen.net/npm/v/marked-jira)](https://www.npmjs.com/package/marked-jira)

[![install size](https://badgen.net/packagephobia/install/marked-jira)](https://packagephobia.now.sh/result?p=marked-jira)

[![downloads](https://badgen.net/npm/dt/marked-jira)](https://www.npmjs.com/package/marked-jira)

[![Test](https://github.com/MrMarble/marked-jira/actions/workflows/test.yaml/badge.svg)](https://github.com/MrMarble/marked-jira/actions/workflows/test.yaml)

A custom renderer for [marked](https://marked.js.org) that generates Jira-compatible markup.

Currently, it supports the following features:

- Headings

- Blockquotes

- Lists

- Code blocks

- Tables

- Links

- Text formatting (bold, italic, underline, strikethrough)

- Horizontal rules

## Demo

Check out the [demo](https://mrmarble.github.io/marked-jira) to see it in action. 👀

## Usage

```javascript

import { marked } from "marked";

import markedJira from "marked-jira";

// or UMD script

// 

// 

marked.use(markedJira(options));

marked.parse("# Hello, world!");

// h1. Hello, world!

```

---

### References

- [Jira Wiki Renderer](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)

- [GitHub Flavored Markdown Spec](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)

- [Markdown link formats](https://gist.github.com/emedinaa/28ed71b450243aba48accd634679f805)