Build (For Developers)

This page is for developers who build Qexed from source.

Requirements

  • Rust stable (rustup recommended)
  • Git
  • On Windows, x86_64-pc-windows-msvc is recommended

Get Source

git clone https://github.com/qexed/Qexed.git
Set-Location "Qexed"
rustup update stable

Build Server Binary

cargo build --release --bin qexed

Build Full Workspace

cargo build --release --workspace

Binaries are under target/release.

Build Tool Packages

cargo build --release -p qexed_tools --bins
cargo build --release -p qexed_config --bin qexed_config_to_mdx

Generate AutoDoc Pages

Both config docs and plugin API docs are generated by qexed_config_to_mdx. The website uses the Next.js app router; plugin API pages are written to app/docs/plugin-api.

cargo run -p qexed_config --bin qexed_config_to_mdx -- --format next-app --out "target/autodoc-config"
cargo run -p qexed_config --bin qexed_config_to_mdx -- --format json --out "target/autodoc-smoke" --plugin-docs-out "E:/code/qexed-website/app/docs/plugin-api"

Developer Notes

  • Prefer stable API for plugin/config integration first.
  • After upgrading Rust/deps, run isolated regression checks.
编辑此页面