Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 2.37 KB

README.md

File metadata and controls

34 lines (26 loc) · 2.37 KB

Markdown-CLI

GitHub issues GitHub GitHub followers GitHub contributors

A markdown CLI renderer in C++

(Still in development, check out this project board 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 <style></style> 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.

Contributing

First of all, thank you for giving us part of your time!
You can contribute by:

Also, check out the license and the code of conduct