See our website for the complete Sprout Documentation.
Sprout Documentation uses VuePress and the VuePress theme for Craft CMS documentation.
Documentation Markdown files are stored in the /docs folder
Some useful commands while working with the docs:
| Command | Notes |
|---|---|
| npm install | Get everything working |
| npm run docs:dev | Spins up a VuePress dev server so you can update Markdown and see those updates in real time in your browser (without generating a static site) |
| npm run docs:build | Generates static site (no need to run this if submitting pull requests, this is handled during deployment) |
To generate metadata using the php ./src/optimizeMetadata.php script you will need to install the following package:
composer require kub-at/php-simple-html-dom-parser
Feedback, requests for examples, and pull requests are welcome.