Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barrelstrength/sprout-docs
Documentation for the Sprout Plugins for Craft CMS
https://github.com/barrelstrength/sprout-docs
craftcms documentation sprout
Last synced: 12 days ago
JSON representation
Documentation for the Sprout Plugins for Craft CMS
- Host: GitHub
- URL: https://github.com/barrelstrength/sprout-docs
- Owner: barrelstrength
- Created: 2017-11-05T19:10:14.000Z (about 7 years ago)
- Default Branch: craft-v4
- Last Pushed: 2024-07-08T12:47:56.000Z (6 months ago)
- Last Synced: 2024-07-08T15:57:26.471Z (6 months ago)
- Topics: craftcms, documentation, sprout
- Language: Vue
- Homepage: https://sprout.barrelstrengthdesign.com/docs/
- Size: 21.9 MB
- Stars: 2
- Watchers: 3
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Support: docs/support/coding-guidelines.md
Awesome Lists containing this project
README
# Sprout Docs
See our website for the complete [Sprout Documentation](https://sprout.barrelstrengthdesign.com/docs/).
## Updating the docs
Sprout Documentation uses [VitePress](https://vitepress.dev/).
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) |
## Contributions
Support questions and requests for examples for all plugin documentation are managed in the [main Sprout Framework repository][#sprout].
- [Ask a question][#questions]
- [Report an issue][#issues]
[#issues]: https://github.com/barrelstrength/sprout/issues
[#questions]: https://github.com/barrelstrength/sprout/discussions/categories/q-a
[#sprout]: https://github.com/barrelstrength/sprout