A living documentation of the components used, essentially, on liip.ch. The goal of this documentation is to illustrate all the elements available and therefor have an overview of the style and behavior of the interface of the website.
For more information about this project, visit styleguide.liip.ch.
- Clone the repository
git clone email@example.com:liip/styleguide.git
npm installto install dependencies
npm startto start the development server
Go to localhost:3000.
Build a static version
npm run build
Webpack bundle files in the
dist folder which is then copied over to the
build folder where Fractal exports the documentation. We have two different folder to be able to include
dist within the npm package while ignoring the
Release a new version
Bump the version in package.json, update the Changelog, build, commit, tag, push, publish to npm repository and deploy automatically:
npm run release
Follow the Angular commit guidelines to help generating a clean and readable Changelog.
Use issues to report anything, from bugs to feature requests.
To contribute to this project, open a pull request.
npm run lint to ensure consistency.
You might be interested in the coding standards applied to this project.