https://github.com/margual56/markdown-cli

A markdown CLI parser made in C++
https://github.com/margual56/markdown-cli

cli markdown markdown-cli markdown-parser markdown-to-html

Last synced: 4 months ago
JSON representation

A markdown CLI parser made in C++

• Host: GitHub
• URL: https://github.com/margual56/markdown-cli
• Owner: margual56
• Created: 2021-02-04T10:26:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-11T16:38:20.000Z (over 4 years ago)
• Last Synced: 2024-05-17T06:49:40.277Z (about 1 year ago)
• Topics: cli, markdown, markdown-cli, markdown-parser, markdown-to-html
• Language: C++
• Homepage:
• Size: 70.3 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Markdown-CLI

[![GitHub issues](https://img.shields.io/github/issues/margual56/Markdown-CLI?style=for-the-badge)](https://github.com/margual56/Markdown-CLI/issues)

[![GitHub](https://img.shields.io/github/license/margual56/Markdown-CLI?style=for-the-badge)](https://github.com/margual56/Markdown-CLI/blob/main/docs/LICENSE)

[![GitHub followers](https://img.shields.io/github/stars/margual56/Markdown-CLI?style=for-the-badge)](https://github.com/margual56/Markdown-CLI/stargazers)

[![GitHub contributors](https://img.shields.io/github/contributors/margual56/Markdown-CLI?style=for-the-badge)](https://github.com/margual56/Markdown-CLI/graphs/contributors)

A markdown CLI renderer in C++ 


(Still in development, [check out this project board](https://github.com/margual56/Markdown-CLI/projects/1) to know what we are up to!)

## Goal

Simple syntax, concise commands and versatile while _trying_ to be suckless.

Command | Description

--- | ---

`markdown -i input.md output.html` | Reads the markdown from the file and outputs to another file.

`markdown output.html`             | Reads the markdown from the stdin (optional).

`markdown -i input.md`             | Reads the markdown from the file and writes the output to the stdout.

`markdown -i input.md -s style.css output.html` |  Reads the markdown from the file and outputs to another file, applying the styling rules specified in the css (includes a `` tag in the html head).

`markdown -h` or `markdown --help` | Display the help (manual)

## Manual

The goal is to have here a wiki, implement the manual page and add it to the [tldr pages](https://github.com/tldr-pages/tldr).

## Contributing

First of all, thank you for giving us part of your time!


You can contribute by:

* [Reporting a bug](https://github.com/margual56/Markdown-CLI/issues/new?assignees=margual56&labels=bug&template=bug_report.md&title=%5BBUG%5D+-+short+description+of+problem)

* [Suggesting a new feature](https://github.com/margual56/Markdown-CLI/issues/new?assignees=margual56&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D+-+short+description+of+the+feature+or+request)

* Completing the documentation or the wiki

* Fork this project and contribute!

Also, check out [the license](https://github.com/margual56/Markdown-CLI/blob/main/docs/LICENSE) and the [code of conduct](https://github.com/margual56/Markdown-CLI/blob/main/docs/CODE_OF_CONDUCT.md)