Skip to content

A super simple script which uses the GitHub API to convert your markdown files to GitHub styled HTML site.

Notifications You must be signed in to change notification settings

calganaygun/MDcat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Header image of MDcat

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.

About

A super simple script which uses the GitHub API to convert your markdown files to GitHub styled HTML site.

Resources

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •