Skip to content

fhaynes/website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Amethyst Website

Build Status CC BY-SA License Join the chat

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 Gutenberg 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.

Structure

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/

Building Locally

To generate a local copy of the website, do:

$ ./generate.sh

However, this is a long process as it also generates documentation. If you only care about the website itself for testing purposes, do:

$ ./quick_build.sh

Please note that this last methods requires you to have Gutenberg installed.

The homepage can be found at build/index.html.

Contributing

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.

About

Project website and blog

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 49.5%
  • CSS 41.2%
  • Shell 7.4%
  • JavaScript 1.9%