Skip to content

A generic prototyping template to quickly build a site using USWDS.

Notifications You must be signed in to change notification settings

GSA/sd-prototyping-template

Repository files navigation

Prototyping Template

This is a rapid prototyping template based on Eleventy and USWDS.

It integrates USWDS via the uswds-compile tool.

Usage

Setup

First, fork this repository or just make a copy of it to get your prototype site started.

Install npm dependencies:

npm install

Local server

Run the Eleventy built-in dev server and watch for changes at the same time:

npm start

Prototype development

Configuration

You can find some basic site configuration options in _data/site.js, including the site name, items for the header and footer navigation menus.

Content

Just add Markdown files to the root directory to create new pages. There are already a few example files:

Stylesheets

If you're already running npm start or npm run uswds:watch, USWDS will automatically compile changes to these files and output the compiled resources to /assets/uswds. Otherwise, you can tell USWDS to compile with npx gulp compile.

Other assets

You can add custom images, JavaScript, and other assets under the assets directory.

About

A generic prototyping template to quickly build a site using USWDS.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published