Bootstrap — MakeTime Custom Fork
Bootstrap is a sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.
To get started, check out http://getbootstrap.com!
Bootstrap uses Grunt for its CSS and JavaScript build system, and Jekyll for the written documentation. To use these systems, follow these steps:
- Download and install Node.
- Install the Grunt command line tools,
grunt-cli
, withnpm install -g grunt-cli
. - Navigate to the root
/bootstrap
directory and runnpm install
to install the dependencies from the included package.json file. - Install Ruby if you haven't already, and then Bundler with
gem install bundler
. Runbundle
to install all of the Ruby dependencies like Jekyll and the Sass linter.
TASK | DESCRIPTION |
---|---|
grunt |
Run grunt to run tests locally and compile the CSS and JavaScript into /dist . |
grunt dist |
grunt dist creates the /dist directory with compiled files. |
grunt test |
Runs JSHint and QUnit tests headlessly in PhantomJS. |
grunt docs |
Builds and tests CSS, JavaScript, and other assets which are used when running the documentation locally via jekyll serve . |
grunt watch |
This is a convenience method for watching just Sass files and automatically building them whenever you save. |
Running and serving the documentation locally uses Jekyll. Here's how to access it.
- The Quick Start section above installed Jekyll and Rouge already, so that's taken care of.
- From the root
/bootstrap
directory, runjekyll serve
in the command line. - open [http://localhost:9001] in your browser.
- Bugs and feature requests
- Documentation
- Contributing
- Community
- Versioning
- Creators
- Copyright and license
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:
bootstrap/
├── css/
│ ├── bootstrap.css
│ ├── bootstrap.css.map
│ ├── bootstrap.min.css
│ └── bootstrap.min.css.map
└── js/
├── bootstrap.js
└── bootstrap.min.js
We provide compiled CSS and JS (bootstrap.*
), as well as compiled and minified CSS and JS (bootstrap.min.*
). CSS source maps (bootstrap.*.map
) are available for use with certain browsers' developer tools.
Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://getbootstrap.com. The docs may also be run locally.
- If necessary, install Jekyll (requires v2.5.x).
- Windows users: Read this unofficial guide to get Jekyll up and running without problems.
- Install the Ruby-based syntax highlighter, Rouge, with
gem install rouge
. - From the root
/bootstrap
directory, runjekyll serve
in the command line. - Open http://localhost:9001 in your browser, and voilà.
Learn more about using Jekyll by reading its documentation.
Documentation for v2.3.2 has been made available for the time being at http://getbootstrap.com/2.3.2/ while folks transition to Bootstrap 3.
Previous releases and their documentation are also available for download.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.
Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.
Get updates on Bootstrap's development and chat with the project maintainers and community members.
- Follow @getbootstrap on Twitter.
- Read and subscribe to The Official Bootstrap Blog.
- Join the official Slack room.
- Chat with fellow Bootstrappers in IRC. On the
irc.freenode.net
server, in the##bootstrap
channel. - Implementation help may be found at Stack Overflow (tagged
twitter-bootstrap-3
). - Developers should use the keyword
bootstrap
on packages which modify or add to the functionality of Bootstrap when distributing through npm or similar delivery mechanisms for maximum discoverability.
For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.
Mark Otto
Jacob Thornton
Code and documentation copyright 2011-2015 Twitter, Inc. Code released under the MIT license. Docs released under Creative Commons.