https://github.com/chyroc/mdcat
Go language remake of mdcat, convert markdown to github style html page.
https://github.com/chyroc/mdcat
Last synced: 5 months ago
JSON representation
Go language remake of mdcat, convert markdown to github style html page.
- Host: GitHub
- URL: https://github.com/chyroc/mdcat
- Owner: chyroc
- License: apache-2.0
- Created: 2021-09-24T01:51:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T17:59:02.000Z (almost 3 years ago)
- Last Synced: 2025-04-13T04:41:39.268Z (9 months ago)
- Language: Go
- Homepage: http://chyroc.cn/mdcat/
- Size: 486 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdcat
Go language remake of mdcat.
Uses the GitHub API to convert your markdown files to [GitHub styled](https://primer.style/) HTML site.
## Features
- Light/dark mode
- Code highlighting
- Web and mobile compatible display
- Meta information
## Install
- brew
```shell
brew install chyroc/tap/mdcat
```
- go
```shell
go install github.com/chyroc/mdcat@latest
```
## Usage
Usage is very simple:
```sh
mdcat
```
It automatically generates HTML file in the same directory.
Default HTML Title is filename, you can add `--title` args to modify:
```shell
mdcat --title "Hi, Cat"
```
Default output HTML file is ``, you can add `--output` args to modify:
```shell
mdcat --title "Hi, Cat" --output ./docs/index.html
```
If the markdown file references another markdown file (in the form of [title](./markdown-file.md)), and you want to render the referenced file at the same time, then you can use the `--link` parameter:
```shell
mdcat --title "Hi, Cat" --output ./docs/index.html --link
```
You can also use meta syntax to define the behavior of mdcat:
```markdown
--
title: "Hi Cat"
slug: index.html
--
Hello, World.
```
This Meta is like command: `mdcat --title "Hi, Cat" --output ./index.html `.
## Demo
You can see this markdown file's HTML on:
[here](https://chyroc.github.io/mdcat)
## Thanks
- Thanks for py version: https://github.com/calganaygun/MDcat.
- Thanks to [Karma](https://www.instagram.com/sanmiyorumamaevet/) for the cat illustration in the header.