Fast builds, live reload, GitHub Pages ready
- GitHub Pages ready (safe mode enabled)
- Fast site generation - Using Jekyll to only generate HTML speeds up generation time
- Fast SCSS compilations - High performance gulp task compiles SCSS to CSS
- Live reload - Changes to HTML, CSS and images are instantly injected into the browser.
- Asset pipline - CSS is minified and images are loselessy compressed
- Clone/download repo
yarn install
cd docs && bundle install
- Edit
_config.yml
, change values forurl
andcustom_settings
. - Set your GitHub Pages source to
master branch /docs folder
in your repository settings.
Development (local)
Open 3 terminals and run the following commands (run in parallel).
yarn run jekyll-dev
- Generates site on changes to/public
.yarn run watch-assets
- Compiles SASS and images on changes to/public/assets
.yarn run browser-sync
- Starts web server hosting content from/public
athttp://localhost:3000
and injects changes.
Your site is now available at http://localhost:3000
Production
yarn run build-assets
- Cleans, builds and minifies assets to/docs/assets
.- Push changes to GitHub