Skip to content

Latest commit

 

History

History
19 lines (16 loc) · 1.09 KB

README.md

File metadata and controls

19 lines (16 loc) · 1.09 KB

PX Blue Component Documentation

This repository holds the source code for the landing page at pxblue-components.github.io. It's a single-page React app that links to the separate documentation pages for each framework:

Updating

To update the site, first clone the repository and make a feature branch:

git clone https://github.com/pxblue-components/documentation.git
cd documentation
git checkout -b feature/my-feature

Then you may run yarn && yarn start to start a local server.

Once you have made your changes, push your feature branch and make a Pull Request into the master branch.

Deployment

Deployment of this site is handled automatically through CircleCI and GitHub Pages. Any code that is merged into the master branch will automatically be deployed to pxblue-components.github.io. Updates usually take effect in under a minute.