Liip Styleguide

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.

Project setup

Clone the repository

git clone git@github.com:liip/styleguide.git

Run npm install to install dependencies
Run npm start to 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 build.

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

Package lives at npmjs.com/package/@liip/styleguide. Documentation is deployed to styleguide.liip.ch.

Contribute

Commit guidelines

Follow the Angular commit guidelines to help generating a clean and readable Changelog.

Issues

Use issues to report anything, from bugs to feature requests.

Code

To contribute to this project, open a pull request.

If you make changes in the JavaScript, setup EsLint in your editor or run npm run lint to ensure consistency.

You might be interested in the coding standards applied to this project.