kitsunecafe
/
roxy-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

always proofread

This commit is contained in:
kitsunecafe 2024-02-22 01:44:00 -05:00
parent c31f392182
commit 5771799c76
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
in/pages/overview.md
View File

@ -3,13 +3,13 @@
{% block content %}
Roxy is a static site generator. The hope is that using it will reduce the amount of boilerplate HTML that usually comes with handwriting static websites.
[roxy-cli](https://fem.mint.lgbt/kitsunecafe/roxy-cli) is a tool written using the [roxy-core](https://fem.mint.lgbt/kitsunecafe/roxy-core) which achieves the above goal by using markdown and templating. The default parsers are
[roxy_cli](https://fem.mint.lgbt/kitsunecafe/roxy-cli) is a tool written using the [roxy_core](https://fem.mint.lgbt/kitsunecafe/roxy-core) which achieves the above goal by using markdown and templating. The default parsers are
* [pulldown_cmark](https://docs.rs/pulldown-cmark/0.10.0/pulldown_cmark/) for Markdown to HTML
* [Tera](https://docs.rs/tera/1.19.1/tera/index.html) for templating
* [Syntect](https://docs.rs/syntect/5.2.0/syntect/index.html) for syntax highlighting
When creating the output, Roxy will do its best to preserve the original directory structure with a few changes. Mostly notably, any bare markdown files will be given their own subdirectory and named `index.html`.
This tool was written for my use case and there is a high chance it may not support yours. In that case, do some combination of the following things: open an issue against `roxy-cli`, write your own generator using `roxy-core`, or find another generator (it won't hurt my feelings, promise).
This tool was written for my use case and there is a high chance it may not support yours. In that case, do some combination of the following things: open an issue against `roxy_cli`, write your own generator using `roxy_core`, or find another generator (it won't hurt my feelings, promise).
{% endblock content %}

4
in/pages/quick-start.md
View File

@ -28,10 +28,10 @@ This is my new site!
EOF
```
Build the site with `roxy-cli`.
Build the site with `roxy_cli`.
```bash
roxy-cli ./input/ ./output/
roxy_cli ./input/ ./output/
```
Host the content and view it.