From 027325df3039b4d19b06003df856d7376c58713d Mon Sep 17 00:00:00 2001 From: Ryan McGrath Date: Fri, 24 May 2019 17:25:19 -0700 Subject: [PATCH] README for website collaboration --- website/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 website/README.md diff --git a/website/README.md b/website/README.md new file mode 100644 index 0000000..96ac7dd --- /dev/null +++ b/website/README.md @@ -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/).