Styles to be used on Nuxeo websites
HTML CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo Codebock styling - Highlight JS: Added Feb 21, 2017
elements/header
scss Codeblock: Removed outline Feb 22, 2017
.editorconfig Testing Post install script Feb 17, 2017
.eslintdefaults Initial commit with usage in readme Jan 20, 2017
.eslintrc Initial commit with usage in readme Jan 20, 2017
.gitignore Relocated header and ensured build is done post install. Feb 17, 2017
.sass-lint.yml Initial commit with usage in readme Jan 20, 2017
README.md Merge branch 'master' of github.com:nuxeo/website-styles Feb 21, 2017
bower.json Header & Demo: Created Feb 17, 2017
nodemon.json Header & Demo: Created Feb 17, 2017
package.json 0.2.2 Feb 22, 2017
postcss.json Base styles Feb 17, 2017

README.md

Nuxeo Website Components

Please use EditorConfig plugin for your code editor/IDE.

Using the package

Include with npm

Add the following in your package.json:

"dependencies": {
    "nuxeo-website-styles": "nuxeo/website-styles#v1.0.1",
    ...
}

Add path to SCSS compiler

In compiling the SCSS you need to include the path --include-path ./node_modules/nuxeo-website-styles/scss/ e.g. npm scripts

"build_css": "node-sass --source-map true --source-map-contents --include-path ./client/scss/ --include-path ./node_modules/nuxeo-website-styles/scss/ --output-style compressed --output ./client/css/ ./client/scss/",

Include styles

In SCSS import and include the appropriate styles:

@import 'nuxeo_styles';

@include 'nuxeo-base-styles';
@include 'nuxeo-typography';

Available mixins

Mixin name Description
nuxeo-base Base styles required
nuxeo-typography Standard typography styles
nuxeo-codeblock Codeblock with HighlightJS styling and copy button

Polymer Elements

Run Locally

npm run dev

Change browser

The broswer defaults to chromium-browser but can be changed with the following command and then locally as usual.

npm config set Nuxeo-website:browser firefox

Contributions

Please keep the available mixins table up to date if you add or amend mixins.

Releasing changes

This module is used via npm, please bump the version when changes are made.

Node packages follow Semantic Versioning (SemVer), versions a described by a MAJOR.MINOR.PATCH version.

After you've committed your code, run one of the following:

npm version major # incompatible API changes
npm version minor # add functionality in a backwards-compatible manner
npm version patch # backwards-compatible bug fixes

Then push the version commit and the tags:

git push && git push --tags