diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 25 insertions, 0 deletions
@@ -1,14 +1,39 @@ # Netlify CMS small-business template +This is a small business template built with [Victor Hugo](https://github.com/netlify/victor-hugo) and [Netlify CMS](https://github.com/netlify/netlify-cms). + +## Getting started + +Use our deploy button to get your own copy of the repository: + +[](https://app.netlify.com/start/deploy?repository=https://github.com/netlify-templates/kaldi-hugo-cms-template) + +Once that is done, you need to setup the GitHub integration for Netlify CMS. + +Go to https://github.com/settings/developers and register a new application. + +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: ``` |