roxy-cli/README.md

# Roxy

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

# 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
# config.toml
[roxy]
slug_word_limit = 8 # the max word limit for a slug

[syntect]
theme = "base16-ocean.dark" # the name of the theme for syntax highlighting
theme_dir = "./themes" # directory to load themes into syntect
```
those poor modules, they just wanted to love 2024-02-03 01:23:35 +00:00			`# Roxy`
read it 2024-02-04 11:45:43 +00:00
those poor modules, they just wanted to love 2024-02-03 01:23:35 +00:00			`this is a wip overhaul for my static site generator, roxy. it technically works but it's very rough around the edges.`

meant to say peruse but whatever. added installation section 2024-02-15 03:38:56 +00:00			`# Installation`
			`it's not a published crate yet so you have to compile it for now, sorry`

read it 2024-02-04 11:45:43 +00:00			`# 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
borrow checker doesnt let me have fun 2024-02-05 10:35:12 +00:00			`# config.toml`
pursue self 2024-02-15 03:37:10 +00:00			`[roxy]`
			`slug_word_limit = 8 # the max word limit for a slug`

borrow checker doesnt let me have fun 2024-02-05 10:35:12 +00:00			`[syntect]`
read it 2024-02-04 11:45:43 +00:00			`theme = "base16-ocean.dark" # the name of the theme for syntax highlighting`
pursue self 2024-02-15 03:37:10 +00:00			`theme_dir = "./themes" # directory to load themes into syntect`
read it 2024-02-04 11:45:43 +00:00			```