Skip to content

Repository files navigation

oximo-docs

Documentation site for oximo, a Rust algebraic modeling library for mathematical optimization. Define optimization models declaratively in Rust. Solver-agnostic and type-safe.

Built with Zola, a static site generator. Live at oximo.dev.

Structure

Path What
content/ Markdown docs pages (_index.md, quickstart.md, ...)
templates/ Tera templates. base.html is the page shell
sass/ Styles (compiled to CSS by Zola)
static/ Assets served as-is: JS, fonts, images, wasm
config.toml Site config: base URL, markdown, [extra] theme options

Develop

Requires Zola.

zola serve # dev server with live reload
zola build # output static site to public/
zola check # validate links and markup

Edit docs in content/. Edit layout/styling in templates/ and sass/.

Analytics

This site uses Umami for privacy-friendly, cookieless analytics. The self-hosted tracker (static/js/um.js) is loaded from <head> in templates/base.html. No personal data or cookies are collected.

License

MIT

This project is heavily modified from the Tanuki Zola theme, used under the MIT license. The original theme license is retained in LICENSE-TANUKI.txt.

About

Documentation site for oximo, a Rust algebraic modeling library for mathematical optimization.

Resources

Stars

Watchers

Forks

Contributors

Languages