The USPTO's open source UI style guide, pattern library, and Bootstrap theme.
Clone or download
scottmerker Merge pull request #213 from scottmerker/gh-pages
V1.6.4 - Bug fixes and enhancements
Latest commit 6e9ed18 Sep 6, 2018

README.md

USPTO UI Design Library

Have feedback or questions about the UI Design Library? Create an issue!

About this repository

This is the source code repository for the USPTO UI Design Library. The site is powered by Jekyll, a static site generator that plays well with Github Pages.

Want to contribute?

See our CONTRIBUTING.md file for contribution guidelines.


Building & running locally

Using Vagrant

With Vagrant and Virtualbox installed, do:

vagrant up

Once that's done, which will take a while the first time through, do:

vagrant ssh
cd /vagrant

Now, skip ahead to Running the documentation.

Not using Vagrant

You will need to install Jekyll. You will also need to install Node.js. Node.js powers the front-end build and dependency management tools Grunt and Bower.

Once Jekyll and Node.js are installed, ensure you have Grunt and Bower installed globally with:

npm install grunt-cli -g
npm install bower -g

Then install the project's dependencies with:

npm install
bower install

Running the documentation

This project can be built with SASS(Beta) or LESS. The SASS assets are currently in beta and you may encounter minor correctable visual bugs.

To build the front-end assets (LESS/CSS/JS) with:

grunt build

(Beta) To build the front-end assets (SASS/CSS/JS) with:

grunt buildSass

Note: The SASS files require your project to install Bootstrap Sass with NPM. The SASS files are looking for a 'node_modules' folder.

Run the project with Jekyll:

jekyll serve

This starts Jekyll, which compiles the markdown files into static html files, starts a server for you to view the documentation at, as well as watches for changes and recompiles.

Distribution Builds

After running grunt build and jekyll build, you will have a _site folder that contains the entire static site and resources.

License

Software code created by U.S. Government employees is not subject to copyright in the United States (17 U.S.C. §105). The United States Department of Commerce reserves all rights to seek and obtain copyright protection in countries other than the United States for Software authored in its entirety by the Department of Commerce. To this end, the Department of Commerce hereby grants to recipients a royalty-free, nonexclusive license to use, copy, and create derivative works of the software outside of the United States.

Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an "as-is" basis and the user assumes responsibility for its use. DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States government.