Overview
Yassss is a simple static site starter built by Interdiscipline (Grant Blakeman). It is a Jekyll app that builds CDN-ready static content with proper asset cache-busting. Yassss assumes deployment to Amazon S3 via CircleCI and adds support for a content section/tag that is parsed with Markdown. The goal of Yassss is to provide a quick and easy way to spin up a new static site using Jekyll without much tinkering. It has some opinionated structure to the JavaScript, Sass/CSS, and accompanying linting, but these can be easily changed/removed.
Features
CDN-ready static content - Yassss builds static content that is ready to be deployed to a CDN, specifically Amazon S3. This ensures fast and efficient delivery of website assets.
Asset cache-busting - Yassss includes proper asset cache-busting techniques, ensuring that updated versions of assets are fetched by clients instead of using cached versions.
Content section/tag support - Yassss adds support for a content section/tag that is parsed with Markdown. This allows for easy management of dynamic content within the static site.
Ease of use - Yassss aims to provide a quick and easy way to set up a new static site using Jekyll. It has opinions but allows for easy customization to fit different project needs.
Installation
To install Yassss, follow these steps:
- Use this repository as a template, there is no need to clone it or fork it unless you plan to contribute.
- Copy the
_config.example.ymlfile and rename it as_config.yml. - If you are planning to deploy with CircleCI, leave the
.exampleversion of the file in place and set your environment variables. - Yassss has specific versions of Ruby and Node, so make sure to check the detailed installation instructions if you are new to managing multiple versions of Ruby and Node.
- Install everything by running
yarn install. Thebundle installcommand will be run first and can also be run separately.
Summary
Yassss is a simple static site starter built with Jekyll that aims to make it quick and easy to set up a new static site without much tinkering. It includes features like CDN-ready static content, asset cache-busting, and support for a content section/tag parsed with Markdown. Yassss has opinions but allows for customization to fit different project needs. It also includes support for CircleCI deployment and integrates with AWS for static hosting.