Continuously serve a documentation folder at http://localhost:3000.
When running docs-builder serve, the documentation is not built in full.
Each page will be build on the fly continuously when requested in the browser.
The serve command is also live reload enabled so that file systems changes will be reflected without having to restart the server.
This includes changes to the documentation files, the navigation, or the configuration files.
docs-builder serve [options...] [-h|--help] [--version]
-p|--path <string>
: Path to serve the documentation. Defaults to the{pwd}/docs folder (optional)
--port <int>
: Port to serve the documentation. (Default: 3000)
When your content set includes an API Explorer configuration in docset.yml, docs-builder serve generates API documentation on startup and serves it under /api/{product-key}/. For example, an elasticsearch key produces pages at http://localhost:3000/api/elasticsearch/.
API spec files are watched for changes and regenerated automatically when they're updated.
:::{note}
API generation is skipped when running docs-builder serve --watch. This is a performance optimization for dotnet watch workflows. Run serve without --watch to include API docs in your local preview.
:::