Skip to main content

Cat multiple document files to the terminal

Project description

Github top language Codacy grade Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Version


Project Icon

Cat multiple documents to the terminal. The continuation of CatMD


Document Compatability

Lightweight markup formats

  • Markdown (including CommonMark and GitHub-flavored Markdown)
  • reStructuredText
  • Emacs Org-Mode
  • Emacs Muse
  • Textile
  • txt2tags

HTML formats

  • (X)HTML 4
  • HTML5


  • EPUB version 2 or 3
  • FictionBook2

Documentation formats

  • Haddock markup

Roff formats

  • roff man

TeX formats

  • LaTeX

XML formats

  • DocBook version 4 or 5
  • JATS

Outline formats

  • OPML

Data formats

  • CSV tables

Word processor formats

  • Microsoft Word docx
  • OpenOffice/LibreOffice ODT

Interactive notebook formats

  • Jupyter notebook (ipynb)

Wiki markup formats

  • MediaWiki markup
  • DokuWiki markup
  • TikiWiki markup
  • TWiki markup
  • Jira wiki markup

Terminal 'rendering'

Highlights the following:

  • Headers 1-6
  • Unordered and ordered lists
  • Block quotes
  • Bold, Italic, Strikethrough, inline code
  • Line Break (br)

Renders the following

  • Tables
  • Images (uses catimage for this so they can look a bit blurry...)

Higlights code blocks

  • Uses pygments for code syntax highlighting


For completed components, see the changelog (link below)

Feature Description Status Generate PySimpleGUI widgets -

Install With PIP

pip install catpandoc

Head to for more info



usage: [-h] [--width WIDTH] [--theme THEME] file


Take a look at test/ for an example of how to use catpandoc in your own project. Or take a look at the example below

import json
import pypandoc
from catpandoc import pandoc2ansi, processpandoc

output = json.loads(pypandoc.convert_file("", 'json'))
for block in output["blocks"]:
	pandoc = pandoc2ansi.Pandoc2Ansi(130, 5, (4, 0, 0))
	processpandoc.processBlock(block, pandoc)

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.9.0

Install Python on Windows


choco install python


To install Python, go to and download the latest version.

Install Python on Linux


sudo apt install python3.9

How to run

With VSCode

  1. Open the .py file in vscode
  2. Ensure a python 3.9 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.9)
  3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal


How to update, build and publish

  1. Ensure you have installed the following dependencies Linux
    wget | python3.9
    wget | python3.9
    (wget -UseBasicParsing).Content | python
    (wget -UseBasicParsing).Content | python
  2. Use poetry for the heavy lifting and dephell to generate requirements
    poetry update
    dephell deps convert
  3. Build/ Publish
    poetry build
    poetry publish
    poetry publish --build



Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2
$ git clone

More information can be found at

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community Files


MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)


See the Changelog for more information.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.


Contributions are welcome, please see the Contributing Guidelines for more information.


Thank you for improving the security of the project, please see the Security Policy for more information.



Screenshot 1 Screenshot 2 Screenshot 3


Screenshot 1 Screenshot 2 Screenshot 3

Project details

Download files

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

Files for catpandoc, version 2021
Filename, size File type Python version Upload date Hashes
Filename, size catpandoc-2021-py3-none-any.whl (14.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size catpandoc-2021.tar.gz (12.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page