README for website collaboration
This commit is contained in:
parent
2044ab7fc7
commit
027325df30
1 changed files with 14 additions and 0 deletions
14
website/README.md
Normal file
14
website/README.md
Normal 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/).
|
||||||
Reference in a new issue