Bedrock

Welcome to Bedrock.

Bedrock is a static site generator to easily make HTML prototypes. For more information, please check out the Bedrock homepage.

Installation and usage

First, make sure you have Node 4.2.1 installed. You can find the latest version of Node at NodeJS.org.
Then, install the required ruby gems. At the moment, icon font generation depends on a gem called fontcustom. Install the required gems using bundle install. You will need Bundler for this.
You need to have gulp installed globally to use Bedrock. npm install -g gulp.
Install the project's dependencies:
- npm install
- bundle install
  - You might also need to install fontforge using brew. For download instructions see the fontcustom repo.

gulp: runs the prototype
gulp icon-font: manually run the icon font
gulp modernizr: create a custom Modernizr file using the feature specified in the configuration
gulp build: create a build (which ends up in the dist folder) that can be deployed to a server

The configuration lives in core/config.js. Available options are:

styleguide
- snippetLanguage
  - This influences the snippets shown in the styleguide.
  - jade or html
- colors
  - path to CSS file specifying colors
patternClasses
- which patterns should get extra CSS classes
- this is useful for customizing the styleguide while keeping your main CSS file clean e.g. to show elements that are hidden by default
- specify the pattern as a string and 1 or more classes as an array
modernizr
- minify (boolean)
  - whether modernizr output should be minified
- feature-detects (array)
  - which feature detects should be included when building a custom version of modernizr

Windows usage is not supported at the moment.

Bedrock is MIT licensed.

Bedrock was made by the team at Mono.