9dbac66861
Fixes #132. _(Message COC002)_ |
||
---|---|---|
src | ||
.editorconfig | ||
.gitignore | ||
.npmignore | ||
.sass-lint.yml | ||
.travis.yml | ||
CODE_OF_CONDUCT.md | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
README.md | ||
deploy.js | ||
package-lock.json | ||
package.json |
README.md
mofo-bootstrap
Mozilla Foundation Bootstrap 4 theme.
Usage
For the moment it's recommended that you use one of two methods to include the compiled mofo-bootstrap CSS in your project:
- Include the library in your
package.json
for an npm-managed project by runningnpm install mofo-bootstrap --save
. You can then point your build system at the compiled CSS which resides atnode_modules/mofo-bootstrap/dest/css/mofo-bootstrap.css
. This is the preferred method. - Hotlink to the raw compiled CSS file on Github at
http://mozilla.github.io/mofo-bootstrap/dest/css/mofo-bootstrap.css
from your HTML. This is not recommended for production, but is OK for prototyping or test purposes. Eventually we will put the CSS on a proper CDN.
It's not currently advisable that you extend and compile the mofo-bootstrap SCSS in your project. SCSS doesn't (currently) allow for dynamic import paths, which complicates things when mofo-bootstrap becomes a module. We're working on a reasonable approach for allowing this...
Setup for Development
Run the following commands in your terminal:
git clone https://github.com/mozilla/mofo-bootstrap.git && cd mofo-bootstrap
npm i
npm start
File Structure
dest/ <- Contains compiled code. Don't edit anything in this folder!
src/
├── index.pug <- Template for demo page (Creates: dest/index.html)
└── scss/
├── custom/ <- SCSS for non-Bootstrap modules.
| └── components/ <- SCSS for custom components.
├── overrides/ <- SCSS modules that override or extend Bootstrap components.
├── demo.scss <- SCSS specific to the demo page.
└── mofo-bootstrap.scss <- Primary entry point that defines all imports.
File Naming Conventions
- All files should be named in
hyphenated-lowercase
- SCSS modules/partials should be prefixed with an underscore (
_
) - Bootstrap overrides should be named after their sibling. (For example:
/src/scss/overrides/_type.scss
andbootstrap/scss/_type.scss
)
Linting
To lint your Sass code, run npm run test:sass
Travis is connected to this task and your pull requests will fail if this test doesn't pass locally.
Deploying
Deployment is run automatically after npm version
is invoked as part of the postversion
script.
The npm run deploy
command will deploy a demo page and compiled CSS for the library to the gh-pages
branch of the origin
remote. It will use the latest code on the master
branch of the origin
remote. It's not recommended to run it on its own, because doing so can result in the deployed demo and library not matching the latest published package in npm.