Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.25 KB

README.md

File metadata and controls

39 lines (31 loc) · 1.25 KB
Raw

Pattern Typography

Shared typography for the NYC Opportunity UI Patterns Framework. This repository relies on the configuration files of the Patterns Elements module.

Installation

This assumes you have scaffolded a Patterns CLI project ("Quick start a new project").

npm install @nycopportunity/pattern-elements @nycopportunity/pattern-typography

Add the module include paths to the array configuration in the config/sass.js file.

/**
 * Config
 *
 * @type {Object}
 */
const sass = {
  sourceMapEmbed: true,
  includePaths: [
    `${process.env.PWD}/src/`,
    `${process.env.PWD}/node_modules/`,
    `${process.env.PWD}/node_modules/@nycopportunity/pattern-elements/src/`,  // +
    `${process.env.PWD}/node_modules/@nycopportunity/pattern-typography/src/` // +
  ]
};

Add the module Sass import directives in in the src/scss/_imports.scss file.

/** Elements */
@forward '@nycopportunity/pattern-typography/src/scss/imports'; // This module includes @font-face and needs to be imported before all other declarations.
@forward '@nycopportunity/pattern-elements/src/scss/imports';
/** Elements - end */