Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.44 KB

README.md

File metadata and controls

62 lines (41 loc) · 2.44 KB
Raw

Bedrock

Welcome to Bedrock.

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

Basic installation & first run

  • First, make sure you have Node 6.3.1 installed. You can find the latest version of Node at Nodejs.org.
  • You need to have gulp installed globally to use Bedrock. npm install -g gulp.
  • Install the project's dependencies:
    • npm install
  • Run gulp to start your project.

Major commands

  • gulp: runs the prototype
  • gulp build: create a build (which ends up in the dist folder) that can be deployed to a server

Upgrading bedrock

See the README at https://github.com/mono-company/bedrock-cli .

Configuration

The configuration lives in bedrock.config.js. Available options are:

  • styleguide
    • snippetLanguage
      • This modifies the language snippets shown in the styleguide.
      • jade or html
    • colors
      • path to the SCSS file specifying colors (for the color feature in the styleguide which shows the project's colors in a visual way)
  • ui
    • dark
      • This modifies the base color of the tree and styleguide. This is meant for projects that primarily have a dark "look" in general.
  • icons
    • hasSvgIcons
    • generateIconFont
      • See "Using icon fonts"

Using icon fonts

  • If you want to use icon fonts you need more dependencies than just node. Icon font generation is optional. Set icons.generateIconFont to true in bedrock.config.js to activate icon fonts.
  • In order for the icon font generation to work, install the required gems using bundle install. You will need Bundler for this. We depend on a Ruby gem called fontcustom. Bundler will install the required dependencies.
    • You might also need to install fontforge using brew. For download instructions see the fontcustom repo.

Windows

Windows usage is not supported at the moment.

We have used Bedrock on Windows successfully though. If you encounter any Windows related bugs, please log them under issues.

License

Bedrock is MIT licensed.

Credits

Bedrock was made by the team at Mono with most major contributions by Thomas Tuts.