A starting point for building pattern library documentation as a static site, using Metalsmith and selected plugins.
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
If needed, update package.json
to manage the packages required.
To build the site, serve it locally and watch for changes:
node build
- NPM - Package manager for Javascript
- NVM - Manage multiple active versions of node.js
- Metalsmith
- jstransformer-marked
- jstransformer-nunjucks
- metalsmith-code-highlight
- metalsmith-in-place
- metalsmith-layouts
- metalsmith-serve
- metalsmith-watch
TBC