https://github.com/tacherasasi/mdcli

MarkDown renderer for the terminal (Markdown CLI)
https://github.com/tacherasasi/mdcli

go markdown markdown-renderer tachera tachera-sasi

Last synced: 9 months ago
JSON representation

MarkDown renderer for the terminal (Markdown CLI)

• Host: GitHub
• URL: https://github.com/tacherasasi/mdcli
• Owner: tacheraSasi
• License: mit
• Created: 2025-02-13T11:33:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-13T12:31:23.000Z (over 1 year ago)
• Last Synced: 2025-02-13T12:36:26.020Z (over 1 year ago)
• Topics: go, markdown, markdown-renderer, tachera, tachera-sasi
• Language: Makefile
• Homepage:
• Size: 12.2 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MDCLI

**mdcli** is a simple command-line tool for processing Markdown files.

##  Features

- Accepts a Markdown file as an argument

- Reads and processes the file

- Supports flag-based and positional arguments

##  Installation

Clone the repository and build the project:

```sh

git clone https://github.com/tacheraSasi/mdcli.git

cd mdcli

make build_(your os) #e.g build_linux

go build -o mdcli

```

##  Usage

Run `mdcli` with a Markdown file as an argument:

```sh

./mdcli filename.md

```

or using a flag:

```sh

./mdcli -file=filename.md

```

## ⚡ Example Output

```sh

Processing file: filename.md

```

##  License

This project is licensed under the MIT License.

---

Made with ❤️ in Go by ***Tachera SASI***.