bolt.diy/docs
2025-06-05 20:59:02 -05:00
..
docs docs: add project templates info 2025-06-05 20:12:35 -05:00
images docs: updated setup guide to have more detailed instructions 2024-12-18 23:34:41 +05:30
.gitignore docs: bugfix/formatting faq docs (#1027) 2025-01-10 21:17:32 +05:30
.python-version docs: bugfix/formatting faq docs (#1027) 2025-01-10 21:17:32 +05:30
mkdocs.yml Fix ESLint issues 2025-01-28 11:39:12 +01:00
poetry.lock adding docs 2024-11-24 22:47:12 +05:30
pyproject.toml adding docs 2024-11-24 22:47:12 +05:30
README.md docs: add mkdocs usage instructions 2025-06-05 20:59:02 -05:00

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).