16 lines
1.2 KiB
Markdown
16 lines
1.2 KiB
Markdown
{% extends "../../layouts/topic.tera" %}
|
|
|
|
{% 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
|
|
* [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).
|
|
{% endblock content %}
|
|
|