Source of AlchemyCMS guidelines
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
guides
.gitignore
README.md
build.sh
favicon.ico
netlify.toml
package.json
yarn.lock

README.md

The AlchemyCMS Guides

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

File locations

The actual guides sourcefiles live in the /guides folder.

Preview the guides

Run

yarn install

to install VuePress.

To run a local preview server, run

yarn guides:preview

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

Building

Build the guides html files with:

yarn guides:build

Deployment

Deployment is done automatically via netlify whenever a change is merged into the master 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