/alchemy-guides

📜️ Source of the AlchemyCMS guidelines

Primary LanguageTypeScript

Netlify Status

The AlchemyCMS Guides

The guides are created with VitePress and are written in Markdown.

Deploys by Netlify

File locations

The actual guides sourcefiles live in the /guides folder.

Preview the guides

Run

bun install

to install VitePress.

To run a local preview server, run

bun run guides:preview

The server will be available at http://localhost:8080.

Building

Build the guides html files with:

bun run guides:build

Deployment

Deployment is done automatically via netlify whenever a change is merged into the main branch.

Contributing

  1. Fork it
  2. Create a branch (git checkout -b my-new-guide)
  3. Commit your changes (git commit -am 'Add new guide for elements')
  4. Push to the branch (git push origin my-new-guide)
  5. Create new Pull Request