Skip to main content

Markdown-friendly variant of cat

Project description

mdcat - Markdown-friendly variant of cat

Ever struggling quickly documenting your server configuration files in a Git repo or sharing them with your colleagues for the future reference? Welcome to mdcat.

It is a simple Python 3 command line utility, ingesting file path(s) arguments, and printing their content in Markdown-friendly format.

Moreover, it prints the file's absolute path, mode (permissions), and owner (user + group).


  • Python3 + PIP


Install/upgrade the tool from PyPI using:

$ pip3 install --upgrade mdcat


$ mdcat --help
Usage: mdcat [OPTIONS] [FILES]...

  --version  Show the version and exit.
  --help     Show this message and exit.


$ echo foo >> bar
$ mdcat bar


File: `/home/pavel/mdcat/bar` (`0644 pavel:users`):



Please read for details on our code of conduct, and the process for submitting pull requests to us.


We use SemVer for versioning. For the versions available, see the tags on this repository.



This project is licensed under the MIT License - see the LICENSE file for details.

Project details

Download files

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

Source Distribution

mdcat-1.0.0.tar.gz (4.9 kB view hashes)

Uploaded source

Built Distribution

mdcat-1.0.0-py3-none-any.whl (3.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page