MDCat

MDcat converts Markdown documents to GitHub styled HTML by leveraging the GitHub Markdown API.

Features

• Light/dark mode
• Code highlighting

Installation

Prerequisites

• Go 1.18 or later installed on your system.

Install from source

1. Clone the repository:

   git clone https://github.com/calganaygun/MDcat.git
   cd MDcat
   

2. Build the binary:

   go build -o mdcat mdcat.go
   

3. (Optional) Add to your PATH:

   sudo mv mdcat /usr/local/bin/
   

Direct installation

You can also install directly using Go:

go install github.com/calganaygun/MDcat@latest

Usage

mdcat input.md
# Or
mdcat -i input.md -o output.html

The generated HTML will be placed next to the input file.

Demo

You can see this README rendered here.

Thanks

Special thanks to Karma for the cat illustration in the header.