mirror of
https://github.com/stackblitz-labs/bolt.diy
synced 2025-06-26 18:26:38 +00:00
.. | ||
docs | ||
images | ||
.gitignore | ||
.python-version | ||
mkdocs.yml | ||
poetry.lock | ||
pyproject.toml | ||
README.md |
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
-
Install the documentation dependencies using Poetry:
cd docs poetry install
-
To preview the documentation locally, run:
poetry run mkdocs serve -f mkdocs.yml
This starts a local server and watches for changes.
-
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
inmkdocs.yml
(currently../site
).