Skip to content
The global style of login.gov
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
docs
scripts
src
test
.eslintrc.yml
.gitignore
.nvmrc
.pa11yci.js
.ruby-version
.stylelintrc.json
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE
Makefile
README.md
_config.yml
gulpfile.js
jest-puppeteer.config.js
jest.config.js
package-lock.json
package.json

README.md

identity-style-guide

Installation and usage

See the documentation for installation and usage instructions.

Configuring for development

The following dependencies are required to build the documentation and assets within this repository:

After satisfying the above language dependencies and cloning this repository, install package dependencies with npm:

npm install

In development, build the documentation site with assets, watch source files for changes, and serve the compiled site at localhost:4000 by running:

npm start

Linting

Lint JavaScript and Sass files in src/ by running:

npm run lint

Deploying documentation updates

Documentation deploys are performed automatically upon merging to master by Federalist. Federalist performs the following steps:

  • npm install --production (a no-op, as this package has no production dependencies)
  • npm run federalist
  • bundle install
  • bundle exec jekyll build

More information can be found in Federalist’s How Builds Work.

Publishing to npm

Once you’re satisfied with any updates, do a trial publish to npm by running:

npm publish --dry-run

No need to run any special build steps — the publish script will lint the source JavaScript and Sass files, and clean and re-build all assets before including them in the published package.

If everything looks alright, continue with publishing:

npm publish
You can’t perform that action at this time.