An overview of Figuration, including how to use it, basic templates, examples, and more.
Tooling Setup #
To use our Gruntfile and run our documentation locally, you'll need a copy of Figuration's source files, Node.js, and Grunt. Follow these steps and you should be ready to rock:
- Download and install Node.js, which we use to manage our dependencies.
- Install the Grunt command line tools,
npm install -g grunt-cli.
- Navigate to the root
/figurationdirectory and run
npm installto install our local dependencies listed in package.json.
- Install Ruby, install Bundler with
gem install bundler, and finally run
bundle install. This will install all Ruby dependencies, such as Jekyll and plugins.
- Windows users: Read this guide to get Jekyll up and running without problems.
When completed, you'll be able to run the various Grunt commands provided from the command line.
Using Grunt #
Our Gruntfile includes the following commands and tasks:
||Runs stylelint, JSHint and QUnit tests headlessly in PhantomJS.|
||This is a convenience method for watching just Sass files and automatically building them whenever you save.|
Sass Compiler #
Figuration uses Autoprefixer (included in our Gruntfile and build process) to automatically add vendor prefixes to some CSS properties at build time. Doing so saves us time and code by allowing us to write key parts of our CSS a single time while eliminating the need for vendor mixins.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See
/grunt/autoprefixer-settings.json for details.
Also included in our Gruntfile and build process is postcss-flexbugs-fixes to work around some browser issues for flexbox layout. More information about these issues can be found over at the Flexbugs repository.
Local Documentation #
Running our documentation locally requires the use of Jekyll, a decently flexible static site generator that provides us: basic includes, Markdown-based files, templates, and more. Here's how to get it started:
- Run through the tooling setup above to install Jekyll (the site builder) and other Ruby dependencies with
- From the root
bundle exec jekyll servein the command line.
http://localhost:9001in your browser, and enjoy.
Learn more about using Jekyll by reading its documentation.
Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun