Skip to main content

Automatically convert markup supported by pandoc into PDF/HTML when uploading to JIRA.

Project description

Jirafs-Pandoc
=============

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

For example: it transforms
`markup like this <https://s3-us-west-2.amazonaws.com/coddingtonbear-public/github/jirafs-pandoc/pdf_example.rst>`_
into `markup like this <https://s3-us-west-2.amazonaws.com/coddingtonbear-public/github/jirafs-pandoc/pdf_example.pdf>`_.

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

Project details


Release history Release notifications

This version
History Node

1.2

History Node

1.1

History Node

1.0

History Node

0.9.8

History Node

0.9.7

History Node

0.9.6

History Node

0.9.4

History Node

0.9.3

History Node

0.9.2

History Node

0.9.1

History Node

0.9

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
jirafs-pandoc-1.2.tar.gz (5.9 kB) Copy SHA256 hash SHA256 Source None May 5, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page