Skip to content

Comprehensive technical documentation for Brax Tech: usage guides, build instructions, and contribution guidelines.

Notifications You must be signed in to change notification settings

braxtechnologies/brax-docs

Repository files navigation

📘 Opensource Brax.tech documentation

Built with Zensical - a modern static site generator by the creators of Material for MkDocs.

🚀 Getting Started

1. Create a virtual environment

python3 -m venv .venv
source .venv/bin/activate   # or .venv\Scripts\activate on Windows

2. Install dependencies

pip install -r requirements.txt

3. Run the local dev server

zensical serve

Then open http://localhost:8000

4. Build the static site

zensical build

🔄 Compatibility Note

Zensical is fully compatible with Material for MkDocs configurations. Your existing mkdocs.yml works seamlessly with Zensical, providing:

  • Faster builds - Built with Rust for performance
  • 🎨 Modern design - Clean, professional interface
  • 🔧 Full compatibility - Drop-in replacement for MkDocs
  • 🚀 Active development - Regular updates and improvements

About

Comprehensive technical documentation for Brax Tech: usage guides, build instructions, and contribution guidelines.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •