kitsunecafe/roxy-cli
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
kitsunecafe 2024-02-22 01:39:05 -05:00
parent 5ca505a1c3
commit c2ef25c9cf
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -3,12 +3,14 @@
this is a wip overhaul for my static site generator, roxy. it technically works but it's very rough around the edges.
# Installation
it's not a published crate yet so you have to compile it for now, sorry
```rs
cargo install roxy_cli
```
# Usage
```bash
roxy [INPUT] [OUTPUT]
roxy_cli [INPUT] [OUTPUT]
```
Roxy will read each file from `INPUT` for valid files. It will look for `toml` for data and `md`, `html`, or `tera` for layout an content files. `toml` data is loaded into an object and given to content files (which can be used as variables with Tera placeholders). The content files will be processed first as Markdown, then as a Tera template. The output of this process will write to `OUTPUT`, preserving the original path (relative to `INPUT`).