Auxesia

Auxesia serves Markdown documentation and downloadable skills from a local folder. Browsers receive HTML. Agents can request the original Markdown at the same URL.

Auxesia serves its own documentation from docs.

Run the documentation

The source build requires Rust and Cargo with support for the Rust 2024 edition.

From the repository root, run:

cargo run -- ./docs --dev

Open http://127.0.0.1:8080/ in a browser.

To request the original Markdown, run:

curl -H 'Accept: text/markdown' http://127.0.0.1:8080/

To read the generated documentation and skills list, run:

curl http://127.0.0.1:8080/llms.txt

Install from the checkout

cargo install --path crates/auxesia
auxesia ./docs --dev

The default listen address is 127.0.0.1:8080. Use --listen to select another address:

auxesia ./docs --listen 127.0.0.1:9000

Documentation

• Get started
• Write pages
• Deploy with Docker
• Configuration
• HTTP reference
• Operations
• Skills
• Example skill

Development

Run the workspace tests:

cargo test --workspace