This is the home of Census Accelerate's website.
This project is based off of https://github.com/18F/nsf-sbir.git
Most of the documentation can be found in the NSF wiki.
To set up the site on your local machine, follow these steps:
-
Install and configure Git. If you're not comfortable with the command line, try GitHub Desktop.
-
Download, install, and start Docker Community Edition.
-
Clone the site. More detail on this.
git clone https://github.com/census-coil/coil-website.git
-
Run the site!
./serve
-
Visit at http://localhost:4000/site/
You can create a new page by running the following command:
./new-page [name-of-page]
It will then create a file in the pages directory with the essential Jekyll front matter needed to get the page up and running
To check locally, we use pa11y-ci
.
To get it working, do the following:
- Install
pa11y-ci
on the command line if you haven't already:npm install pa11y-ci -g
- In one terminal tab, get the site running:
a.
./serve
will create a local version of the site at http://localhost:4000/site/ a.bundle exec jekyll serve
will create a local version of the site at http://localhost:4000/ - Then, in a new tab lint the site:
a. If you used the
./serve
command:pa11y-ci --sitemap http://localhost:4000/site/sitemap.xml --sitemap-exclude ".pdf"
b. If you used the bundle exec jekyll serve
command:
sh pa11y-ci --sitemap http://localhost:4000/sitemap.xml --sitemap-exclude ".pdf"
4. Alternatively, to check a single url:
a. If you used the ./serve
command:
sh pa11y-ci http://localhost:4000/site/[name of link]
b. If you used the bundle exec jekyll serve
command:
sh pa11y-ci http://localhost:4000/[name of link]