Table of contents
- Quick start
- Bugs and feature requests
- Copyright and license
This is a Google-styled theme for Bootstrap. Because I'm a fan of the new Google UI seen in Gmail, Docs, Calendar, etc, I decided to reproduce the look of these new UI elements for my own personal use. The project's goal isn't UI parity with Google Apps -- it's feature parity with Bootstrap, themed with Google's UI in mind.
TODC Bootstrap was created by Tim O'Donnell, and maintained with the support and involvement of the community.
Several quick start options are available:
- Download the latest release.
- Clone the repo:
git clone https://github.com/todc/todc-bootstrap.git.
- Install with Bower:
bower install todc-bootstrap.
- Install with Composer:
composer require todc/todc-bootstrap.
NOTE - After cloning/installing todc-bootstrap you must run
grunt checkout-bootstrap from the todc-bootstrap directory. This will download the correct version of the Bootstrap source.
Read the Getting started page for information on the framework contents, templates and examples, and more.
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:
todc-bootstrap/ ├── css/ │ ├── bootstrap.css │ ├── bootstrap.css.map │ ├── bootstrap.min.css │ ├── bootstrap.min.css.map │ ├── bootstrap-theme.css │ ├── bootstrap-theme.css.map │ ├── bootstrap-theme.min.css │ ├── bootstrap-theme.min.css.map │ ├── todc-bootstrap.css │ ├── todc-bootstrap.css.map │ ├── todc-bootstrap.min.css │ └── todc-bootstrap.min.css.map ├── js/ │ ├── bootstrap.js │ └── bootstrap.min.js ├── fonts/ │ ├── glyphicons-halflings-regular.eot │ ├── glyphicons-halflings-regular.svg │ ├── glyphicons-halflings-regular.ttf │ ├── glyphicons-halflings-regular.woff │ └── glyphicons-halflings-regular.woff2 └── img/ └── checkmark.png
We provide compiled CSS and JS (
bootstrap.*, todc-bootstrap.*), as well as compiled and minified CSS and JS (
bootstrap.min.*, todc-bootstrap.min.*). CSS source maps (
bootstrap.*.map, todc-bootstrap.*.map) are available for use with certain browsers' developer tools. Fonts from Glyphicons are included, as is the optional Bootstrap theme.
This is being tested in the latest versions of Chrome, Firefox, and IE8+.
The following projects are specifically designed for use with todc-bootstrap:
- LESS - for compiling
.lessfiles into CSS
- Bootstrap - this will be automatically checked out, if necessary, during the build process
Bugs and feature requests
Note that feature requests must target TODC Bootstrap v4, because TODC Bootstrap v3 is now in maintenance mode and is closed off to new features. This is so that we can focus our efforts on TODC Bootstrap v4.
v4-dev branch is not yet available.
TODC Bootstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://todc.github.io/todc-bootstrap/. The docs may also be run locally.
Running documentation locally
- If necessary, install Jekyll and other Ruby dependencies with
bundle install. Note for Windows users: Read this unofficial guide to get Jekyll up and running without problems.
- From the root
bundle exec jekyll servein the command line.
http://localhost:9002in 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://todc.github.io/todc-bootstrap/2.3.2/ while folks transition to TODC Bootstrap 3.
Previous releases and their documentation are also available for download.
We welcome contributions from everyone. While contributing, please follow the project code of conduct, so that everyone can be included.
Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.
TODC Bootstrap v3 is now closed off to new features. It has gone into maintenance mode so that we can focus our efforts on TODC Bootstrap v4, the future of the theme. Pull requests which add new features (rather than fix bugs) should target TODC Bootstrap v4 (the
v4-dev git branch) instead.
v4-dev branch is not yet available.
TODC Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
The first set of
<major>.<minor>.<patch> is the Bootstrap version while the second set is the todc-bootstrap version.
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
For more information on SemVer, please visit http://semver.org/.
See the Releases section of our GitHub project for changelogs for each release version of TODC Bootstrap.
Copyright and license
NOTE This project was previously and incorrectly licensed under the Public Domain. It has now been changed to be compatible with Bootstrap's current license.
Inspired by Bootstrap and, of course, Google.