Jersey is a set of styles for Centresource internal and project documentation. It is primarily utilized for Almanac, but may be used in other sites. Read the installation section for more information for getting up and running.
- Load normalize.css.
- Load FontAwesome.
- Load jQuery 2.0+.
- Embed the Jersey Typekit found in the Centresource account.
Copy the following to your project:
dist/assets/css/dist/assets/img/dist/assets/js/
Include Jersey assets in your HTML <head>:
<link href="stylehseet" src="path/to/jersey.css"/>
<script src="path/to/jersey.flyover.js"></script>
<script src="path/to/jersey.headroom.js"></script>
<script src="path/to/jersey.anchors.js"></script>Add Jersey to your bower.json dependencies.
{
"name": "My Project",
"version": "0.0.1",
"dependencies": {
"jersey": "[email protected]:centresource/jersey.git#1.0.0", // Replace with desired version
}
}Install via Bower.
bower installInclude Jersey assets in your HTML <head>:
<link href="stylehseet" src="path/to/jersey.css"/>
<script src="path/to/jersey.flyover.js"></script>
<script src="path/to/jersey.headroom.js"></script>
<script src="path/to/jersey.anchors.js"></script>Please read the contributing guidelines. This project utilizes Playbook, reference Playbook's setup guide.
- Clone this repository
npm installbower installbundle install
- Bump the version number in
bower.json. - Build the compiled assets:
grunt build - Commit changes:
git commit -m "Version bump." - Tag the release:
git tag -a v#.#.# -m "Version #.#.# - Push commits and tags to origin:
git push origin master --tags
Serve your source locally into your browser. LiveReload will automatically load any changes to HTML, CSS and JavaScript that you make.
Check the quality of your source with tools like JSLint, CSSLint and csscss.
Run any test that you have defined for your source.
Build the concatenated, minified production version of the source into the dist directory.