An open API service indexing awesome lists of open source software.

https://github.com/patternplate/patternplate

📘 patternplate connects design and engineering to establish a single source of truth for your team.
https://github.com/patternplate/patternplate

component-library documentation livingstyleguide patternplate

Last synced: about 1 month ago
JSON representation

📘 patternplate connects design and engineering to establish a single source of truth for your team.

Awesome Lists containing this project

README

          

> Documentation and development interface for component libraries

# patternplate

## [Site][site] | [Getting started][getting-started] | [Join us on Gitter][gitter]

This is the contributor documentation for the `patternplate` mono-repository.
For user docs see [patternplate.github.io](https://patternplate.github.io)

* Framework independent
* Bring design docs to live with real components
* Powerful search and meta data system

## Contribute to patternplate

```sh
git clone https://github.com/patternplate/patternplate.git
cd patternplate
yarn
yarn start

# start the local component library
yarn patternplate start
```

## Publish a release

```bash
yarn clean
yarn
yarn test
yarn build
yarn run pack
yarn lerna publish
yarn lerna run clean:dev # remove publishing bundles
```

## Code of Conduct

We want to build an open and welcoming environment for **everyone**. That is why we expect from **everyone** to follow our [Code of Conduct](https://github.com/patternplate/patternplate/blob/master/.github/CODE_OF_CONDUCT.md)

## License

Copyright by SinnerSchrader. All `@patternplate` packages are released under the MIT license.

[site]: https://patternplate.github.io/
[getting-started]: https://patternplate.github.io/doc/docs/guides/getting-started?guides-enabled=true
[gitter]: https://gitter.im/patternplate/Lobby