README for website collaboration

This commit is contained in:
Ryan McGrath 2019-05-24 17:25:19 -07:00
parent 2044ab7fc7
commit 027325df30
No known key found for this signature in database
GPG key ID: 811674B62B666830

14
website/README.md Normal file
View file

@ -0,0 +1,14 @@
# Alchemy Website
The source for `alchemy.rs`, which is hosted on GitHub Pages.
## To Edit...
This website is a static site, backed by [Zola](https://www.getzola.org/documentation/getting-started/installation/). You'll need to install it to develop it locally. Otherwise... have at it.
If you make substantial changes, make sure the build command outputs to the proper directory:
```
zola build --output-dir /path/to/alchemy/docs/folder
```
## Questions, Comments?
Open an issue, or hit me up on [Twitter](https://twitter.com/ryanmcgrath/).