makudaun 0.0.2

Markdown renderer tool made on Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

<header>
<img src="https://www.orzklv.uz/favicons/pinned.svg" alt="logo" height="100" align="left">
<h1 style="display: inline">Makudaun!</h1>

Render markdown files to HTML using GitHub flavored themes.

</header>

[![GitHub top language](https://img.shields.io/github/languages/top/orzklv/makudaun?style=flat-square&logo=github)](https://github.com/orzklv/makudaun)
[![Channel](https://img.shields.io/badge/Chat-grey?style=flat-square&logo=telegram)](https://t.me/orzklvb)
[![Shellcheck CI](https://github.com/orzklv/makudaun/actions/workflows/test.yml/badge.svg)](https://github.com/orzklv/makudaun/actions/workflows/test.yml)

## About

Makudaun is a simple markdown renderer that uses GitHub flavored themes. It is written in Rust and uses [markdown alpha](https://github.com/wooorm/markdown-rs) 
as a Markdown parser.

> Everytime I used my old makudaun written on TypeScript, I started feeling like a idiot myself... So here you are!

## Features

- GitHub Flavor
- Dark theme support

## Install (Automatic)

You may use cargo to install the binary:

```shell
cargo install makudaun
```

## Install (Manual)

Visit the releases page on GitHub, download the latest binary and put it in your PATH. Link to the latest release: [Releases](https://github.com/orzklv/makudaun/releases/latest)

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE](license) file for details.