bolt.diy/docs/README.md
2025-06-05 20:59:02 -05:00

848 B

Documentation Overview

This directory contains the sources used to generate the bolt.diy documentation site. It uses MkDocs with the Material theme to build a static site from the files in docs/docs. The build configuration lives in mkdocs.yml.

Building or Serving the Docs

  1. Install the documentation dependencies using Poetry:

    cd docs
    poetry install
    
  2. To preview the documentation locally, run:

    poetry run mkdocs serve -f mkdocs.yml
    

    This starts a local server and watches for changes.

  3. To generate the static site, run:

    poetry run mkdocs build -f mkdocs.yml
    

    The site will be output to the directory specified by site_dir in mkdocs.yml (currently ../site).