- Tooling setup
- Using Grunt
- Local documentation
- Howto create an icons library using icomoon
To use our Gruntfile and run our documentation locally, you’ll need a copy of Bootstrap’s source files, Node, and Grunt. Follow these steps and you should be ready to rock:
- Download and install Node, which we use to manage our dependencies.
- Install the Grunt command line tools,
npm install -g grunt-cli.
- Navigate to the root
/bootstrapdirectory 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 unofficial 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.
Our Gruntfile includes the following commands and tasks:
||Runs scss-lint, ESLint and QUnit tests headlessly in PhantomJS (used for CI).|
||This is a convenience method for watching just Sass files and automatically building them whenever you save.|
Bootstrap 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 like those found in v3.
We maintain the list of browsers supported through Autoprefixer in a separate file within our GitHub repository. See
/grunt/postcss.js for details.
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.
- Open http://localhost:9001 in your browser, and voilà.
Learn more about using Jekyll by reading its documentation.
Howto create an icons library using icomoon
Create your own project
Go to the top left menu and select
import project link and select the file
It will load all the Orange Icons into a new project
You can now access to all the icons by clicking onto
Select your icons
You will find 2 sets : the 1st one contains all the Orange Frames and Popout, the 2nd one contains all the Solaris icons.
By default there is no selected icon, you can make your selection for your own project.
Check that you are in selection mode (3rd icon in the top bar, after
import icons and
icon library), when an icon is selected, its border becomes yellow.
If you need to add a specific icon which is no present into the selection provided, create a new empty set for your project, and add icons to it.
Warning! Icons format recommendation
You need to import icons in SVG, within a square layout to preserve icons consistency ; if the layout is not a square, you will have some surprises.
Download and adapt your project font
Have you finished your shopping?
Now you can create your font for your project.
generate font at the bottom right of the page.
Depending of the number of icons selected, it can take a little bit of time…
Setting your font preferences
Now you have a
Download button at the bottom right but WAIT!!!
We know, you want to download your font but first you need to make some change into
preferences to name your font with a name dedicated to YOUR project.
On the top menu bar, click onto
By default the font-family is named
orange-icons, rename it for your project (MYPROJECT-icons or other) and customize the class prefix by adding your project name to create a unique css selector.
You also can get Stylesheet variables for scss or less and if you want change the version.
And uncheck IE8 support if you rely on Boosted 4!
Close the Preferences window, you’re now ready to download your font.
The download is a zip file,
The demo.html and demo-files folder offer a sample page displaying the icons - you don’t need them for your project.
The fonts folder is the one you need! It contains
MYPROJECT-icons.eot, svg, ttf and woff files
And finally the “style.css” file contains all the css classes.
Rename it to
Adapt your file for SCSS or LESS if needed, you can now use your icons.
Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun