Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.37 KB

README.md

File metadata and controls

48 lines (32 loc) · 1.37 KB

Pattern library documentation

A starting point for building pattern library documentation as a static site, using Metalsmith and selected plugins.

How do I get set up?

Installation

From within the project root

# Switch your version of Node to the correct version for this project (see .nvmrc)
nvm use

# Install dependencies
npm install

Configuration

NPM config file

If needed, update package.json to manage the packages required.

Build

To build the site, serve it locally and watch for changes:

node build

Dependencies

Deployment instructions

TBC