Install Booyaka

🔗Use Nimble (Recommended)

The recommended way to install Booyaka is via nimble, the package manager for Nim. First, ensure you have Nim installed on your system. You can find installation instructions on the Nim website. Once you have Nim set up, run the following command to install Booyaka:

nimble install booyaka

🔗Download Precompiled Binaries

You can also download precompiled binaries for your operating system from the Booyaka Releases page. Choose the appropriate binary for your OS (Linux, macOS, or Windows), download it, and place it in a directory included in your system's PATH.

Ensure that you have the necessary permissions to execute the downloaded binary. You may need to adjust the file permissions using

chmod +x booyaka on Unix-based systems.

🔗Running Booyaka

Once you have Booyaka installed, you can quickly generate a new documentation website via the command line interface.

booyaka new my_docs_site

Navigate to the newly created directory:

booyaka run --port:8000 --sync

Get a list of all available commands and options by running:

booyaka --help