Cat multiple document files to the terminal
Project description
CatPandoc
Cat multiple documents to the terminal. The continuation of CatMD
- Features
- Roadmap
- Install With PIP
- Use
- Language information
- Install Python on Windows
- Install Python on Linux
- How to run
- Changelog
- Download
- Licence
- Screenshots
Features
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
Ebooks
- 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
Roadmap
For completed components, see the changelog (link below)
Feature | Description | Status |
---|---|---|
pandoc2pysimplegui.py | Generate PySimpleGUI widgets | - |
Install With PIP
pip install catpandoc
Head to https://pypi.org/project/catpandoc/ for more info
Use
CLI
usage: application.py [-h] [--width WIDTH] [--theme THEME] file
Import
Take a look at test/catcomplex.py 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("cheatsheet.md", 'json'))
for block in output["blocks"]:
pandoc = pandoc2ansi.Pandoc2Ansi(130, 5, (4, 0, 0))
processpandoc.processBlock(block, pandoc)
print(pandoc.genOutput())
Language information
Built for
This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.
Install Python on Windows
Chocolatey
choco install python
Download
To install Python, go to https://www.python.org/ and download the latest version.
Install Python on Linux
Apt
sudo apt install python3.8
How to run
With VSCode
- Open the .py file in vscode
- Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
- Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
From the Terminal
./[file].py
Changelog
See the CHANGELOG for more information.
Download
Clone
Using The Command Line
- Press the Clone or download button in the top right
- Copy the URL (link)
- Open the command line and change directory to where you wish to clone to
- Type 'git clone' followed by URL in step 2
$ git clone https://github.com/FHPythonUtils/CatPandoc
More information can be found at https://help.github.com/en/articles/cloning-a-repository
Using GitHub Desktop
- Press the Clone or download button in the top right
- Click open in desktop
- Choose the path for where you want and click Clone
More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
Download Zip File
- Download this GitHub repository
- Extract the zip archive
- Copy/ move to the desired location
Licence
MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)
Screenshots
Desktop
Themes
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.