See our website for the complete Sprout Documentation.
Sprout Documentation uses VitePress.
Documentation Markdown files are stored in the /docs
folder. For each major Craft release, all documentation pages are copied to a new version of the docs and updated for any changes in that release. Previous versions of the docs are archived on their respective branches.
Some useful commands while working with the docs:
Command | Notes |
---|---|
npm install | Get everything working |
npm run docs:dev | Spins up a VitePress dev server) |
npm run docs:build | Generates static site, handled during deployment) |
Support questions and requests for examples for all plugin documentation are managed in the main Sprout Framework repository.