code-gov-about-page

Component for the About page on code.gov.

Install

The repository is distributed with npm. After installing npm, you can install code-gov-about-page with this command:

$ npm i @code.gov/code-gov-about-page

Usage

This package is meant to be used with the code-gov-front-end project. Please follow the configuration settings for the project.

Link this package to edit Code.gov About content locally

You may want to view your content changes in the code-gov-about-page repo on your local machine for testing. Follow these steps to do so:

Clone the latest version of the code-gov-about-page repository.
Run npm install to install the dependencies required for the package in the code-gov-about-page directory.
Run npm link in the root level of the code-gov-about-page directory on your local machine.
On the code-gov-front-end project, clone the repository and run npm install if you haven’t done this already.
Run npm link @code.gov/about-page in the root level of the code-gov-front-end directory on your local machine.

You are now using the latest version of the code.gov About page section via your cloned version when running the code-gov-front-end site on your local machine. To stop using this version, run npm unlink @code.gov/code-gov-about-page from the root level of the code-gov-front-end directory.

Public domain

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Questions?

Create a new Issue: https://github.com/GSA/code-gov-about-page/issues/new

Email: code@gsa.gov

Join our #opensource-public Slack channel: https://chat.18f.gov/

Follow us for updates

Twitter: @CodeDotGov LinkedIn: code-gov