ncarb-bootstrap
v4.0.0-beta.1
Published
NCARB-styled bootstrap
Downloads
8
Maintainers
Readme
Table of contents
- Quick start
- NCARB notes
- Status
- What's included
- Bugs and feature requests
- Documentation
- Contributing
- Community
- Versioning
- Creators
- Copyright and license
Quick start
Several quick start options are available:
- Clone the repo:
git clone https://github.com/ncarb/bootstrap.git
- Install with npm:
npm install ncarb-bootstrap
- Install with yarn:
yarn add ncarb-bootstrap
- Install with Bower: `bower install ncarb-bootstrap'
- Install with NCARB’s NuGet: CSS:
Install-Package ncarb-bootstrap
Sass:Install-Package ncarb-bootstrap.sass
Read the Getting started page for information on the framework contents, templates and examples, and more.
NCARB notes
Scripts
Use npm run
to execute npm scripts found in package.json
Notable scripts:
npm run docs-serve
: runs http://localhost:9001npm run watch-css
: rebuilds css on sass changesnpm run docs-push
: updates docs by pushing latest docs up to gh-pages branchnpm run release-version old new
: updates version everywhere
Keeping up with Bootstrap
We plan to occasionally merge bootstrap updates into this repository.
Status
What's included
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.
Bugs and feature requests
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.
Documentation
Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://getbootstrap.com. The docs may also be run locally.
Documentation search is powered by Algolia's DocSearch. Working on our search? Be sure to set debug: true
in the _scripts.html
include.
Running documentation locally
- Run through the tooling setup to install Jekyll (the site builder) and other Ruby dependencies with
bundle install
. - Run
npm run test
(or a specific NPM script) to rebuild distributed CSS and JavaScript files, as well as our docs assets. - From the root
/bootstrap
directory, runbundle exec jekyll 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 previous releases
Documentation for v2.3.2 has been made available for the time being at https://getbootstrap.com/2.3.2/ while folks transition to Bootstrap 3.
Previous releases and their documentation are also available for download.
Contributing
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.
Versioning
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.
See the Releases section of our GitHub project for changelogs for each release version of Bootstrap. Release announcement posts on the official Bootstrap blog contain summaries of the most noteworthy changes made in each release.
Creators
Mark Otto
Jacob Thornton
Copyright and license
Code and documentation copyright 2011-2017 the Bootstrap Authors and Twitter, Inc. Code released under the MIT License. Docs released under Creative Commons.