This is the source code for the Amethyst website and blog, accessible from either https://amethyst.github.io/website/ or https://www.amethyst.rs/. The HTML is generated by Zola and hosted online with GitHub Pages.
Any changes to the master branch of this repository should automatically
trigger a rebuild and republish of the site through Travis CI.
| Content | Source Path | Website Path |
|---|---|---|
| Main Content | src/content |
/ |
| News from Amethyst | src/content/blog |
/blog/ |
| Amethyst Book | amethyst/book/src |
/book/ |
| Generated API Documentation | amethyst/src/ |
/doc/ |
To generate a complete local copy of the website with documentation, run:
$ ./generate.sh
Note that this is a long process. If you are looking to get up and running quickly for development, first install Zola and then run the following:
$ cd src && zola serve
This will generate temporary files in src/public as well as start a local server with live updates. When the server is stopped, all generated files will be cleaned up and deleted.
Alternatively, you can run ./quick_build. This is similar to cd src && zola build. Note that this folder is in the project root under build, and will not automatically delete itself. The homepage can be found at public/index.html.
We are a community project that welcomes contribution from anyone. If you're interested in helping out, please read the CONTRIBUTING.md file before getting started. Don't know what to hack on? Feel free to search though our issue tracker.