Skip to content
This repository was archived by the owner on Nov 11, 2025. It is now read-only.

readme: instruct how to serve the docs pages #13

Open
wscherphof wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme: instruct how to serve the docs pages #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
```
```

### 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