JSPM

markdown2jira

0.0.4
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q32063F
  • License MIT

Export Markdown document to JIRA JSON import file

Package Exports

  • markdown2jira

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (markdown2jira) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

markdown2jira

Node.js library that converts Markdown file to JIRA JSON file ready for import.

Markdown Epics and Stories syntax

Source file must be in Markdown syntax. H1 headers are associated as epics. H2 headers are stories. All content under H2 headers will be part of user story as a description.

Input file must have at least one epic.

# First epic

## As a user I want this story in my JIRA project.

Some *description* of user story.

More text:
* aaa
* bbb
* ccc

## As a user I want this second story in my JIRA project.

Another description.

# Second epic

## As a user I want this story in second epic.

A description.

!(Image description)[http://www.img.com/img1.jpg]

Usage

node index.js PROJECT_JIRA_KEY MARKDOWN_FILENAME [URL_TO_ATTACHMENTS] [ISSUE_KEY_OFFSET]

PROJECT_JIRA_KEY - JIRA project key. For example "ABC"

MARKDOWN_FILENAME - Path to source Markdown file

[URL_TO_ATTACHMENTS] - Prefix for declared images (optional). Default: ""

[ISSUE_KEY_OFFSET] - ID of first Epic (optional). Default: 1

Generated JSON file can be used for import to JIRA.