idfkit-docs

EnergyPlus documentation built with Zensical.

Documentation | GitHub

Development

This project uses uv for dependency management and Zensical to build the documentation site.

Setup

# Clone the repository
git clone https://github.com/idfkit/idfkit-docs.git
cd idfkit-docs
# Install dependencies and pre-commit hooks
make install

Commands

make install # Install dependencies and pre-commit hooks
make check # Run pre-commit hooks
make docs # Serve documentation locally
make docs-test # Test documentation build

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.