From 8971d6c34267813c070037d01a8bbedec3fb6818 Mon Sep 17 00:00:00 2001 From: Wouter Scherphof Date: Wed, 26 Jan 2022 21:25:21 +0100 Subject: [PATCH] instruct how to serve the docs pages --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc4d32b..b126bde 100644 --- a/README.md +++ b/README.md @@ -89,4 +89,14 @@ or only the compon you need: ```scss @use 'path-to-node_modules/mdc-pug/lib/styles/button'; @use 'path-to-node_modules/mdc-pug/lib/styles/typography'; -``` \ No newline at end of file +``` + +### Docs + +The documentation pages can be served from the package repo: + +1. Clone `https://github.com/olegpolyakov/mdc-pug.git` +1. `cd mdc-pug` +1. `npm install` +1. `npm run docs` +1. Browse to http://localhost:8080