Skip to content

mickenorlen/alchemy-guides

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The AlchemyCMS Guides

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

Deploys by Netlify

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

About

📜️ Source of the AlchemyCMS guidelines

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 50.1%
  • JavaScript 48.4%
  • Shell 1.5%