Package Exports

asciidoctor-jira
asciidoctor-jira/src/asciidoctor-jira.js

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 (asciidoctor-jira) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Asciidoctor Jira Extension

A set of macros for https://github.com/asciidoctor/asciidoctor.js[Asciidoctor.js] to integrate Jira!

Install

Node.js

Install the dependencies:

[source, shell]

npm i asciidoctor asciidoctor-kroki

Create a file named jira.js with following content and run it:

[source, javascript]

const asciidoctor = require('@asciidoctor/core')() const jira = require('asciidoctor-jira')

const input = 'jira::DOC[]'

jira.register(asciidoctor.Extensions) // <1> console.log(asciidoctor.convert(input, { safe: 'safe' }))

const registry = asciidoctor.Extensions.create() jira.register(registry) // <2> console.log(asciidoctor.convert(input, { safe: 'safe', extension_registry: registry }))

<1> Register the extension in the global registry <2> Register the extension in a dedicated registry

Antora Integration

If you are using https://antora.org/[Antora], you can integrate Jira in your documentation site.

Install the extension in your playbook project:

npm i asciidoctor-jira

asciidoc:
  extensions:
    - asciidoctor-jira

Usage

block macro

inline macro

Configuration

Macro type	Attribute name	Description	Default value
block	`jql`	Define the query to obtain issues from jira instance.	`resolution='Unresolved' ORDER BY priority DESC, key ASC, duedate ASC`