content goes here
...
PMG's Bootstrap Theme
https://github.com/agencypmg/pmg-bootstrap-theme
Last synced: 3 months ago
JSON representation
PMG's Bootstrap Theme
# PMG Bootstrap Theme
This is the offical bootstrap theme for PMG's internal tools.
This is a seperate style guide from the PMG Website and Branding Guidelines,
and should not be combined.## Installation
```
npm install --save @agencypmg/bootstrap-theme
```## Usage
### Webpack
You'll need a few loaders:
```
npm install --save-dev sass-loader css-loader \
resolve-url-loader css-loader
```Then include `bootstrap-sass` and `@agencypmg/bootstrap-theme` in your
`sass-loader` configuration.```js
var path = require('path');
var ExtractTextPlugin = require("extract-text-webpack-plugin");var sassOptions = {
sourceMap: true,
outputStyle: 'compressed',
// setup bootstrap and @agencypmg/bootstrap!
includePaths: [
path.join(__dirname, 'node_modules', 'bootstrap-sass', 'assets', 'stylesheets'),
path.join(__dirname, 'node_modules', '@agencypmg', 'bootstraptheme', 'assets')
]
};
var ex = new ExtractTextPlugin({
filename: 'css/[name].css',
});
var rules = [
// ...
{
test: /\.scss$/,
loader: ex.extract({
use: [{
loader: 'css-loader',
options: {
import: false,
url: true
}
}, {
loader: 'resolve-url-loader'
}, {
loader: 'sass-loader',
options: sassOptions,
}],
fallback: 'style-loader'
})
}
];
```### Using the Precompiled Version
If you would like the compiled version that has bootstrap already included, you
can use the dist folder.```html
```
## HTML Examples
### Navigation
Your navigation should following the bootstrap HTML example: http://getbootstrap.com/components/#navbar
Logo/title should follow mirror this example:
```
![]()
{tool_title}
```### Body
This theme adds a min-height to the content, for this you need to add a class named `main` to the body content wrapping divided. I.e.
```html
...
content goes here
...
```
### Footer
The footer should follow this HTML:
```html
© PMG Worldwide, LLC. All rights reserved.
```
## Development
```
npm install
# work work work
```### Compiling
```
./bin/compile
```### Compiling
To publish a new version on NPM, update the tag in [package.json](https://github.com/AgencyPMG/PMG-Bootstrap-Theme/blob/master/package.json#L3)
Once your PR is merged type `npm publish` in terminal.