dokugile/README.md

28 lines
679 B
Markdown
Raw Normal View History

2024-06-06 19:53:10 +02:00
# dokugile
Simple document generator from Markdown to Html.
# demo
![demo](demo/demo.gif)
# how to use
These steps are indicated for _Debian_ based distros.
2024-06-11 21:35:06 +02:00
* _Pandoc_ version 3.1.13 or higher is required. You can try to install it by running
2024-06-06 19:53:10 +02:00
```bash
sudo apt-get install pandoc
```
2024-06-11 21:35:06 +02:00
> although you will find a newer version here: https://github.com/jgm/pandoc/releases
2024-06-06 19:53:10 +02:00
* Download and execute _dokugile_ binary
```bash
sudo chmod +x dokugile
./dokugile
```
* or execute _cargo run_ from source
```bash
git clone https://git.lainoa.eus/aitzol/dokugile.git
cd dokugile
cargo run
```
* Once you have created your document edit it as many times as you need to keep it up to date.