From 7ddc1c01e47b7df33a01e0c80a7c372c7712708b Mon Sep 17 00:00:00 2001 From: Darin Dimitroff Date: Wed, 11 Jan 2017 14:32:24 +0200 Subject: Updates README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cadcd38..eba1333 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -A small business template for Netlify CMS based on Hugo +## 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 `` tag like so: + +``` + + + +``` -- cgit v1.3