cpe-patterns
v4.11.0
Published
A pattern library authoring environment
Downloads
87
Readme
CPE Patterns
CPE's Pattern Library, powered by Drizzle
Usage
You can see the pattern library at https://cpe-patterns.netlify.com/
To use the CPE patterns CSS or JS, you can get it via:
npm i cpe-patterns
Documentation
Development
This will start a BrowserSync server on localhost:3000
npm start
Publishing a new version
Make sure you have the latest npm version (npm i -g npm
)
npm version <new version here>
(in a PR)- This will update the version number in
package.json
,package-lock.json
, andCHANGELOG.md
- This will update the version number in
npm publish
(onmaster
, after PR is merged)
Using your local version of cpe-patterns
in another project
In your local cpe-patterns
folder:
npm link
- registers the module globallynpm start
- starts watcher
In a repo that uses cpe-patterns
:
npm link cpe-patterns
- This pointsnode_modules/cpe-patterns
to your localcpe-patterns
folder
When you want to switch back to the published version of cpe-patterns
, just run npm i
Babel Exclusions
We exclude Snapper from Babel, because it causes problems, including preventing the Film Strip navigation in the Carousel pattern from operating.
In general, we prefer to run our dependencies through Babel for consistency, but do not remove this exclusion unless prepared to invest a significant amount of time troubleshooting.