Styleguide and Frontend Assets
CSS HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
build
dist
quartz-css
quartz-js
quartz-svg
.gitignore
.jshintrc
CHANGELOG.md
Gruntfile.js
README.md
VERSION
package.json
publish
server
setup

README.md

Quartz

quartz

Style guide & elements + asset build pipeline for VHX.

Getting Started

Note: Currently for VHX internal use.

Initial Setup

  1. Clone the repo
  2. Run ./setup
  3. Done.

Starting the server

  1. Run ./server
  2. Go to: http://quartz.dev

Build and Release

Note: Currently for VHX internal use. You will need permissions to push changes to the quartz repo (VHX team members) and the quartz npm package.

Release Steps

The publish script will build, tag, and publish to NPM for use across VHX applications.

  1. Squash and Merge PR
  2. Checkout Master branch locally
  3. Update VERSION (using Semantic Versioning)
  4. Update CHANGELOG (add new entry using VERSION's number, the date, and description from PR)
  5. Run ./publish

Using in your Application

First install via NPM.

npm install @vhx/quartz

Then include Quartz files as needed.

Include all of Quartz core (in SASS or LESS). This does not include icons.

@import '~@vhx/quartz/dist/quartz.css';

// minified
@import '~@vhx/quartz/dist/quartz.min.css';

Or include individual features and icons (in SASS or LESS).

@import '~@vhx/quartz/dist/grid.css';
@import '~@vhx/quartz/dist/icon-code.css';