Skip to main content

Jirafs-Pandoc

Automatically converts many kinds of markup into fancy PDF files when uploading to JIRA.

For example: it transforms markup like this into markup like this.

Installation

  1. Install from PIP:

    pip install jirafs-pandoc
  2. Enable for a ticket folder:

    jirafs plugins --enable=pandoc

Note that you can globally enable this (or any) plugin by adding the --global flag to the above command:

jirafs plugins --global --enable=pandoc

Requirements

Depending upon which output format you utilize, your requirements may vary:

  • PDF Output: Both pandoc and xelatex are required.

  • Other output formats: Only pandoc is required.

Supported Input Formats and Extensions

  • Text Formats (extra)

    • *.text

    • *.txt

  • HTML (html)

    • *.html

    • *.htm

  • JSON (pandoc AST) (json)

    • *.json

  • Latex (latex)

    • *.latex

    • *.tex

    • *.ltx

  • Markdown (markdown)

    • *.markdown

    • *.mkd

    • *.md

    • *.pandoc

    • *.pdk

    • *.pd

    • *.pdc

  • Native Pandoc (native)

    • *.hs

  • reStructuredText (rst)

    • *.rst

  • Textile (textile)

    • *.textile

Supported Output Formats

Common output formats include:

  • PDF (pdf)

  • HTML (html)

  • RTF (rtf)

But, you can use any output format supported by Pandoc. Please check which formats your version of Pandoc supports by running:

pandoc --help

Optional Configuration

  • Default Input Formats: markdown, reStructuredText, and textile. See Configuring Input Formats for details on how to limit or expand which files will be transformed.

  • Default Output Format: PDF. See Configuring Output Format for details on how to set which output format will be used.

Configuring Input Formats

By default, only markdown, reStructuredText, and textile files are transformed, but you can change which files will be transformed on a format or extension basis using either the pandoc.enabled_input_extensions or the pandoc.enabled_input_formats settings.

To limit to only specific extensions, set the pandoc.enabled_input_extensions setting; for example, to only transform reStructuredText and textile documents into PDFs, you would run:

jirafs config --set pandoc.enabled_input_extensions rst,textile

To limit to only specific formats, set the pandoc.enabled_input_formats setting. To limit to transforming only markdown and textile documents, you could run:

jirafs config --set pandoc.enabled_input_formats markdown,textile

Configuring Output Format

By default, markup files will be converted into PDF files, but you can convert to HTML (or any other supported format) instead by setting the pandoc.output_format setting:

jirafs config --set pandoc.output_format html

Metadata

Release files for jirafs-pandoc 1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jirafs-pandoc 1.2
File Size Uploaded Provenance Actions
jirafs-pandoc-1.2.tar.gz 5.9 kB Without provenance Details for jirafs-pandoc-1.2.tar.gz

Release files / jirafs-pandoc-1.2.tar.gz

Download URL jirafs-pandoc-1.2.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
1d1106f101a387b9798186d7b2b03d46823f826081779879ba8be3895eec6a71
BLAKE2b-256 checksum
How to use checksums
a8314beea0ddfcf1eee665dc80e3f830b7b2702b8b7af1f8a36763b781916c98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for jirafs-pandoc 1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page