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

read it

Browse source
This commit is contained in:
KitsuneCafe 2024-02-04 06:45:43 -05:00
parent 7298594f6e
commit 5d89a8aebe
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,3 +1,21 @@
# Roxy
this is a wip overhaul for my static site generator, roxy. it technically works but it's very rough around the edges.
# Usage
```bash
roxy [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`).
# Configuration
Currently, Roxy only has two configuration keys
```toml
theme = "base16-ocean.dark" # the name of the theme for syntax highlighting
themes = ["./themes/base16-ocean.dark.tmTheme"]
```