Important
Starting with Alchemy CMS 9.0, alchemy-guides lives in the guides/ directory of the Alchemy CMS repository
Please open issues and pull requests for new guidelines there.
The guides are created with VitePress and are written in Markdown.
The actual guides sourcefiles live in the /guides folder.
Run
pnpm installto install VitePress.
To run a local preview server, run
pnpm run guides:previewThe server will be available at http://localhost:8080.
Build the guides html files with:
pnpm run guides:buildDeployment is done automatically via netlify whenever a change is merged into the main branch.
- Fork it
- Create a branch (
git checkout -b my-new-guide) - Commit your changes (
git commit -am 'Add new guide for elements') - Push to the branch (
git push origin my-new-guide) - Create new Pull Request