ickc/pannb

.. This is auto-generated from `docs/README.md`. Do not edit this file directly.

=============================
pannb—pandoc filter for ipynb
=============================

:Date:   January 25, 2022

.. contents::
   :depth: 3
..

|Documentation Status| |image1|

|GitHub Actions| |Coverage Status| |image2| |Codacy Badge| |Scrutinizer Status| |CodeClimate Quality Status|

|Supported versions| |Supported implementations| |PyPI Wheel| |PyPI Package latest release| |GitHub Releases| |Development Status| |Downloads| |Commits since latest release| |License|

|Conda Recipe| |Conda Downloads| |Conda Version| |Conda Platforms|

Introduction
============

Pandoc supports ipynb format. What this does is add support of

1. jupytext style yaml metadata block
2. filter out the Python code block
3. convert raw block to native pandoc AST, e.g.

   -  if a cell outputs HTML, then it is an HTML raw block by default, meaning only HTML-like output formats contains these output cells. This filter convert them using pandoc itself to native pandoc AST so that any output formats will contains the same output.

These 3 filters are implemented as 3 individual functions, so that you can cherry-pick your own combinations (See `API doc <https://ickc.github.io/pannb/api/pannb/>`__). The command line program ``pannb`` have all 3 included.

Example
=======

See ```docs/example.ipynb`` <https://github.com/ickc/pannb/blob/master/docs/example.ipynb>`__ for the input notebook and its `output without the filter <https://ickc.github.io/pannb/example/>`__ and `output with the filter <https://ickc.github.io/pannb/example-output/>`__.

Supported pandoc versions
=========================

pandoc versioning semantics is `MAJOR.MAJOR.MINOR.PATCH <https://pvp.haskell.org>`__ and panflute’s is MAJOR.MINOR.PATCH. Below we shows matching versions of pandoc that pannb supports, in descending order. Only major version is shown as long as the minor versions doesn’t matter.

+-------+------------------+---------------------------+-------------------------------+
| pannb | panflute version | supported pandoc versions | supported pandoc API versions |
+=======+==================+===========================+===============================+
| 0.1.2 | 2.1.3            | 2.17.x                    | 1.22.1                        |
+-------+------------------+---------------------------+-------------------------------+
| 0.1.1 | 2.1.3            | 2.15–2.16.x               | 1.22–1.22.1                   |
+-------+------------------+---------------------------+-------------------------------+
| 0.1.0 | 2.1              | 2.11.2—2.14.x             | 1.22                          |
+-------+------------------+---------------------------+-------------------------------+

.. |Documentation Status| image:: https://readthedocs.org/projects/pannb/badge/?version=latest
   :target: https://pannb.readthedocs.io/en/latest/?badge=latest&style=plastic
.. |image1| image:: https://github.com/ickc/pannb/workflows/GitHub%20Pages/badge.svg
   :target: https://ickc.github.io/pannb
.. |GitHub Actions| image:: https://github.com/ickc/pannb/workflows/Python%20package/badge.svg
.. |Coverage Status| image:: https://codecov.io/gh/ickc/pannb/branch/master/graphs/badge.svg?branch=master
   :target: https://codecov.io/github/ickc/pannb
.. |image2| image:: https://coveralls.io/repos/ickc/pannb/badge.svg?branch=master&service=github
   :target: https://coveralls.io/r/ickc/pannb
.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/7e7a6e8e440149aaa6358884efa941b0
   :target: https://www.codacy.com/gh/ickc/pannb/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ickc/pannb&utm_campaign=Badge_Grade
.. |Scrutinizer Status| image:: https://img.shields.io/scrutinizer/quality/g/ickc/pannb/master.svg
   :target: https://scrutinizer-ci.com/g/ickc/pannb/
.. |CodeClimate Quality Status| image:: https://codeclimate.com/github/ickc/pannb/badges/gpa.svg
   :target: https://codeclimate.com/github/ickc/pannb
.. |Supported versions| image:: https://img.shields.io/pypi/pyversions/pannb.svg
   :target: https://pypi.org/project/pannb
.. |Supported implementations| image:: https://img.shields.io/pypi/implementation/pannb.svg
   :target: https://pypi.org/project/pannb
.. |PyPI Wheel| image:: https://img.shields.io/pypi/wheel/pannb.svg
   :target: https://pypi.org/project/pannb
.. |PyPI Package latest release| image:: https://img.shields.io/pypi/v/pannb.svg
   :target: https://pypi.org/project/pannb
.. |GitHub Releases| image:: https://img.shields.io/github/tag/ickc/pannb.svg?label=github+release
   :target: https://github.com/ickc/pannb/releases
.. |Development Status| image:: https://img.shields.io/pypi/status/pannb.svg
   :target: https://pypi.python.org/pypi/pannb/
.. |Downloads| image:: https://img.shields.io/pypi/dm/pannb.svg
   :target: https://pypi.python.org/pypi/pannb/
.. |Commits since latest release| image:: https://img.shields.io/github/commits-since/ickc/pannb/v0.1.3.svg
   :target: https://github.com/ickc/pannb/compare/v0.1.3...master
.. |License| image:: https://img.shields.io/pypi/l/pannb.svg
.. |Conda Recipe| image:: https://img.shields.io/badge/recipe-pannb-green.svg
   :target: https://anaconda.org/conda-forge/pannb
.. |Conda Downloads| image:: https://img.shields.io/conda/dn/conda-forge/pannb.svg
   :target: https://anaconda.org/conda-forge/pannb
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/pannb.svg
   :target: https://anaconda.org/conda-forge/pannb
.. |Conda Platforms| image:: https://img.shields.io/conda/pn/conda-forge/pannb.svg
   :target: https://anaconda.org/conda-forge/pannb