If you are cloning this template to run locally, you will need to add your Algolia IDs to a new config/env.js file. You can copy the what is in the env.example.js.
Be sure to change you Algolia Application ID and Search-Only API Key in the liveSearch.js as well.
If you are deploying this to Netlify, you can use the Deploy to Netlify below and add your Algolia IDs as ENV variables.
Getting started
Use our deploy button to get your own copy of the repository:
Once that is done, you need to setup the GitHub integration for Netlify CMS.
Then go to the "Access" tab in your new Netlify site and add a GitHub authentication provider.
Once that's done, you'll be able to enter the CMS by going to the URL of your new site and appending /admin
Local Development
Clone this repository, and run yarn or npm install from the new folder to install all required dependencies.
Then start the development server with yarn start or npm start.
Layouts
The template is based on small, content-agnostic partials that can be mixed and matched. The pre-built pages showcase just a few of the possible combinations. Refer to the site/layouts/partials folder for all available partials.
Use Hugo’s dict functionality to feed content into partials and avoid repeating yourself and creating discrepancies.
CSS
The template uses a custom fork of Tachyons and PostCSS with cssnext and cssnano. To customize the template for your brand, refer to src/css/imports/_variables.css where most of the important global variables like colors and spacing are stored.
SVG
All SVG icons stored in site/static/img/icons are automatically optimized with SVGO (gulp-svgmin) and concatenated into a single SVG sprite stored as a a partial called svg.html. Make sure you use consistent icons in terms of viewport and art direction for optimal results. Refer to an SVG via the <use> tag like so: