https://github.com/studio24/pattern-library-docs
https://github.com/studio24/pattern-library-docs
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/studio24/pattern-library-docs
- Owner: studio24
- Created: 2020-10-02T10:18:36.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-26T17:33:14.000Z (over 5 years ago)
- Last Synced: 2026-01-18T02:14:00.054Z (5 months ago)
- Language: SCSS
- Size: 848 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pattern library documentation
A starting point for building pattern library documentation as a static site, using [Metalsmith](https://metalsmith.io/) and selected plugins.
## How do I get set up?
### Installation
From within the project root
```bash
# 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](http://localhost:8081) and watch for changes:
```bash
node build
```
## Dependencies
- [NPM](https://www.npmjs.com/) - Package manager for Javascript
- [NVM](https://github.com/creationix/nvm) - Manage multiple active versions of node.js
- [Metalsmith](https://github.com/segmentio/metalsmith)
- [jstransformer-marked](https://github.com/jstransformers/jstransformer-marked)
- [jstransformer-nunjucks](https://github.com/jstransformers/jstransformer-nunjucks)
- [metalsmith-code-highlight](https://github.com/fortes/metalsmith-code-highlight)
- [metalsmith-in-place](https://github.com/metalsmith/metalsmith-in-place)
- [metalsmith-layouts](https://github.com/metalsmith/metalsmith-layouts)
- [metalsmith-serve](https://github.com/mayo/metalsmith-serve)
- [metalsmith-watch](https://github.com/FWeinb/metalsmith-watch)
## Deployment instructions
TBC