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.
| 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 |
dev/ |
Development-only page overrides, published under /dev/ |
versions/ |
Archived documentation sources for published versions |
config.toml |
Site config: base URL, markdown, [extra] theme options |
Requires Zola.
zola serve # dev server with live reload
zola build # output static site to public/
zola check # validate links and markupEdit docs in content/. Edit layout/styling in templates/ and sass/.
The deployment-equivalent combined build is bash ./build.sh. It publishes the stable root,
configured version archives, and the /dev/ channel.
zola serve serves only the stable content tree.
The root site is the latest stable documentation channel. The combined Cloudflare build also
publishes archived release channels and a development channel at
oximo.dev/dev. The development build starts from the stable content
and overlays files from dev/, so a page only needs to be copied into dev/ when it diverges
from the latest release.
To release a new stable version, promote the tested development files into content/, update
stable_version, dev_label, and [extra.versions] in config.toml, and merge that promotion
through the release branch. The build then continues to publish stable /, configured versions/
archives, and development /dev/ from one artifact.
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.
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.