UI kit for mindsmash applications.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
docs
gulp Fix github.io path Apr 18, 2016
source
.bowerrc
.gitignore
LICENSE
README.md
bower.json
gulpfile.js
package.json

README.md

mindsmash-ui

A Bootstrap 3 UI Kit by mindsmash.

Contents

Heads up! This theme uses a non-default font called "Source Sans Pro".
Please add the following line of code to your <head>:

    <link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,400italic" rel="stylesheet">

Install with bower to use the theme (CSS or SCSS version)

$ bower install mindsmash-ui

Use in a Sass (SCSS) project

Include the theme variables before adding any bootstrap files

You need to install boostrap yourself ($ bower install bootstrap-sass), as it is no dependency of this project (the css version already includes bootstrap).

@import "path/to/mindsmash-ui/dist/scss/variables"; // to override bootstrap's variables
@import "/path/to/bootstrap-sass/assets/stylesheets/bootstrap"; // load original bootstrap
@import "path/to/mindsmash-ui/dist/scss/mindsmash-ui"; // then load our own styles

Use with pure CSS

Include the mindsmash-ui.css to your website, it includes the complete bootstrap css files:

<head>
  <!-- add the mindsmash-ui theme -->
  <link rel="stylesheet" href="path/to/mindsmash-ui/css/mindsmash-ui.css">

  <!-- then add your custom styles -->
  <link rel="stylesheet" href="path/to/custom.css">
</head>

Install with npm to change and deploy the theme

You need:

  • node.js with npm
  • gulp

Clone the project, then follow the instructions below.

Development mode

$ npm install Install all dependencies

$ gulp dev Start development mode: a demo page is started. Edit html or scss and see updates in realtime

Publish a new version

$ gulp build Create new release files in dist/.

$ npm version <patch|minor|major> Automatically update package.json and create a git tag.

$ git push --follow-tags Push the tagged version, this creates a new bower version.

Contribute

If you want to contribute to this project, simply fork it on Github, do your changes and create a pull request that describes your changes. If it's all nice and clean, it might get merged.