Skip to content

Latest commit

 

History

History
26 lines (20 loc) · 1.14 KB

README.md

File metadata and controls

26 lines (20 loc) · 1.14 KB

Design System / Style Guide Boilerplate

A very simple starter boilerplate for a front-end style guide. It uses CodeMirror for it's syntax highlighting, and comes with highlighting for CSS, Sass, HTML and JSX out of the box. (See footer.hmtl)

Features

  • CSS Autoprefixing
  • Nunjucks templating
  • CodeMirror editor-in-the-browser and syntax highlighting.
  • Built-in preview server with BrowserSync
  • Automagically compile Sass with libsass
  • Automagically lint your scripts
  • Map compiled CSS to source stylesheets with source maps
  • Awesome image optimization
  • Automagically wire-up dependencies installed with Bower
  • The gulpfile makes use of ES2015 features by using Babel

Getting Started

  • Install dependencies: npm install & bower install
  • Run gulp serve to preview and watch for changes
  • Run bower install --save <package> to install frontend dependencies
  • Run gulp serve:test to run the tests in the browser
  • Run gulp to build for production
  • Run gulp serve:dist to preview the production build