This repository houses the documentation and website files for the City of Philadelphia's Digital Standards. The UI components, and other assets can be found in the standards repository.
The City of Philadelphia's Digital Standards is compiled using the static site generator, Hugo. It uses npm scripts for task running and Yarn for package management.
You will need to have the following installed to run a local version of the site:
- Node.js v4.2.3+ - Install guides
- Yarn v0.23.4+ - Install guides
- Hugo v0.20.7+ - Install guides
To install dependencies and prepare to work on the site, enter the folder with your local copy of the site in a terminal window and run:
yarn
To start a local server, run:
hugo serve
The local webserver will be available at: http://localhost:1313/
To watch for changes to CSS and JavaScript assets, in a separate terminal window run:
yarn watch
Template markup and assets live in the themes/phila.gov
directory.
Hugo comes with LiveReload, which will automatically refresh your browser on changes.
Commits to the master
branch will trigger a build of the site through Travis CI.