Skip to content
This repository was archived by the owner on Jul 12, 2018. It is now read-only.

Commit e5b8f13

Browse files
author
Melody Kramer
committed
first commit
0 parents  commit e5b8f13

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+4827
-0
lines changed

‎Gemfile

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source 'https://rubygems.org'
2+
3+
gem 'jekyll'
4+
gem 'rouge'

‎Gemfile.lock

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
blankslate (2.1.2.4)
5+
celluloid (0.16.0)
6+
timers (~> 4.0.0)
7+
classifier-reborn (2.0.3)
8+
fast-stemmer (~> 1.0)
9+
coffee-script (2.4.1)
10+
coffee-script-source
11+
execjs
12+
coffee-script-source (1.9.1.1)
13+
colorator (0.1)
14+
execjs (2.5.2)
15+
fast-stemmer (1.0.2)
16+
ffi (1.9.9)
17+
hitimes (1.2.2)
18+
jekyll (2.5.3)
19+
classifier-reborn (~> 2.0)
20+
colorator (~> 0.1)
21+
jekyll-coffeescript (~> 1.0)
22+
jekyll-gist (~> 1.0)
23+
jekyll-paginate (~> 1.0)
24+
jekyll-sass-converter (~> 1.0)
25+
jekyll-watch (~> 1.1)
26+
kramdown (~> 1.3)
27+
liquid (~> 2.6.1)
28+
mercenary (~> 0.3.3)
29+
pygments.rb (~> 0.6.0)
30+
redcarpet (~> 3.1)
31+
safe_yaml (~> 1.0)
32+
toml (~> 0.1.0)
33+
jekyll-coffeescript (1.0.1)
34+
coffee-script (~> 2.2)
35+
jekyll-gist (1.2.1)
36+
jekyll-paginate (1.1.0)
37+
jekyll-sass-converter (1.3.0)
38+
sass (~> 3.2)
39+
jekyll-watch (1.2.1)
40+
listen (~> 2.7)
41+
kramdown (1.7.0)
42+
liquid (2.6.2)
43+
listen (2.10.1)
44+
celluloid (~> 0.16.0)
45+
rb-fsevent (>= 0.9.3)
46+
rb-inotify (>= 0.9)
47+
mercenary (0.3.5)
48+
parslet (1.5.0)
49+
blankslate (~> 2.0)
50+
posix-spawn (0.3.11)
51+
pygments.rb (0.6.3)
52+
posix-spawn (~> 0.3.6)
53+
yajl-ruby (~> 1.2.0)
54+
rb-fsevent (0.9.5)
55+
rb-inotify (0.9.5)
56+
ffi (>= 0.5.0)
57+
redcarpet (3.3.2)
58+
rouge (1.9.0)
59+
safe_yaml (1.0.4)
60+
sass (3.4.15)
61+
timers (4.0.1)
62+
hitimes
63+
toml (0.1.2)
64+
parslet (~> 1.5.0)
65+
yajl-ruby (1.2.1)
66+
67+
PLATFORMS
68+
ruby
69+
70+
DEPENDENCIES
71+
jekyll
72+
rouge

‎LICENSE.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
As a work of the United States Government, this project is in the
2+
public domain within the United States.
3+
4+
Additionally, we waive copyright and related rights in the work
5+
worldwide through the CC0 1.0 Universal public domain dedication.
6+
7+
## CC0 1.0 Universal Summary
8+
9+
This is a human-readable summary of the
10+
[Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
11+
12+
### No Copyright
13+
14+
The person who associated a work with this deed has dedicated the work to
15+
the public domain by waiving all of his or her rights to the work worldwide
16+
under copyright law, including all related and neighboring rights, to the
17+
extent allowed by law.
18+
19+
You can copy, modify, distribute and perform the work, even for commercial
20+
purposes, all without asking permission.
21+
22+
### Other Information
23+
24+
In no way are the patent or trademark rights of any person affected by CC0,
25+
nor are the rights that other persons may have in the work or in how the
26+
work is used, such as publicity or privacy rights.
27+
28+
Unless expressly stated otherwise, the person who associated a work with
29+
this deed makes no warranties about the work, and disclaims liability for
30+
all uses of the work, to the fullest extent permitted by applicable law.
31+
When using or citing the work, you should not imply endorsement by the
32+
author or the affirmer.

‎README.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## 18F Guides Template
2+
3+
This is a skeleton repo containing the
4+
[CFPB/DOCter](https://github.com/CFPB/DOCter)-based
5+
[Jekyll](http://jekyllrb.com/) template for
6+
[18F Guides](http://18f.github.io/guides/).
7+
8+
### Generating the site/hosting locally
9+
10+
You will need [Ruby](https://www.ruby-lang.org) ( > version 2.1.5 ). You may
11+
consider using a Ruby version manager such as
12+
[rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) to
13+
help ensure that Ruby version upgrades don't mean all your
14+
[gems](https://rubygems.org/) will need to be rebuilt.
15+
16+
On OS X, you can use [Homebrew](http://brew.sh/) to install Ruby in
17+
`/usr/local/bin`, which may require you to update your `$PATH` environment
18+
variable:
19+
20+
```shell
21+
$ brew update
22+
$ brew install ruby
23+
```
24+
25+
To create a new guide and serve it locally, where `MY-NEW-GUIDE` is the name
26+
of your new repository:
27+
28+
```shell
29+
$ git clone git@github.com:18F/guides-template.git MY-NEW-GUIDE
30+
$ cd MY-NEW-GUIDE
31+
$ ./go init
32+
$ ./go serve
33+
```
34+
35+
This will check that your Ruby version is supported, install the [Bundler
36+
gem](http://bundler.io/) if it is not yet installed, install all the gems
37+
needed by the template, and launch a running instance on
38+
`http://localhost:4000/guides-template/`. (Make sure to include the trailing slash! The built-in
39+
Jekyll webserver doesn't redirect to it.) That page contains further
40+
instructions on how to adapt the template to a new guide repository.
41+
42+
After going through these steps, run `./go` to see a list of available
43+
commands. The `serve` command is the most common for routine development.
44+
45+
You'll need to create a new Github repository for your new guide. To do this, go to github.com/18f and click the "New Repository" button. Enter the title and description for your new guide and then click "Create Repository".
46+
47+
After the repository is created, you'll see the repo URL at the top. Copy this url by hitting the handy "Copy to Clipboard" button next to the text box.
48+
49+
Go back to the directory where you cloned the guides-template repository. We're going to change this repo to point to the one you just created (which is empty) and push the template to it.
50+
```
51+
git remote set-url origin https://github.com/18F/MY-NEW-GUIDE.git
52+
git push origin 18f-pages
53+
```
54+
55+
Now you can edit the template freely, and push up changes as you need.
56+
57+
### Staging version
58+
59+
You can create an `18f-pages-staging` branch and changes to that branch will
60+
be published to `https://pages.18f.gov/staging/MY-NEW-GUIDE`.
61+
62+
TODO(mbland): Finish
63+
64+
### Public domain
65+
66+
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
67+
68+
> 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](https://creativecommons.org/publicdomain/zero/1.0/).
69+
>
70+
> All contributions to this project will be released under the CC0
71+
>dedication. By submitting a pull request, you are agreeing to comply
72+
>with this waiver of copyright interest.
73+
# open-source-guide

‎_config.yml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
baseurl: /open-source-guide
2+
markdown: redcarpet
3+
name: 18F Open Source Style Guide
4+
exclude:
5+
- go
6+
- copy-template
7+
- Gemfile
8+
- Gemfile.lock
9+
- README.md
10+
- LICENSE.md
11+
12+
permalink: pretty
13+
highlighter: rouge
14+
15+
# Author/Organization info to be displayed in the templates
16+
author:
17+
name: 18F
18+
url: https://18f.gsa.gov
19+
20+
# Point the logo URL at a file in your repo or hosted elsewhere by your organization
21+
logourl: /assets/img/18f-logo.png
22+
logoalt: 18F logo
23+
24+
# Navigation
25+
# List links that should appear in the site sidebar here
26+
navigation:
27+
- text: Introduction
28+
url: index.html
29+
internal: true
30+
- text: Naming Your Project
31+
url: naming-your-project/
32+
internal: true
33+
- text: Writing The Repo Description
34+
url: writing-the-repo-description/
35+
internal: true
36+
- text: Making READMEs readable
37+
url: making-readmes-readable/
38+
internal: true
39+
- text: Writing Clear and Concise Issues
40+
url: writing-clear-and-concise-issues/
41+
internal: true
42+
- text: Best Practices For Using the Wiki
43+
url: using-the-wiki/
44+
internal: true
45+
- text: GitHub Repo Checklist
46+
url: github-repo-checklist/
47+
internal: true
48+
49+
repos:
50+
- name: 18F Open Source Style Guide
51+
description: Main repository
52+
url: https://github.com/18F/open-source-guide
53+
54+
# Style Variables
55+
brand_color: "#1188ff"
56+
57+
google_analytics_ua: UA-48605964-19

‎_includes/analytics.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Google Analytics -->
2+
<script>
3+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
4+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
5+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
6+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
7+
ga('create', '{{ site.google_analytics_ua }}', 'gsa.gov');
8+
9+
// anonymize user IPs (chops off the last IP triplet)
10+
ga('set', 'anonymizeIp', true);
11+
12+
ga('send', 'pageview');
13+
</script>
14+
15+
<!-- Digital Analytics Program roll-up, see https://analytics.usa.gov for data -->
16+
<script id="_fed_an_ua_tag" src="https://analytics.usa.gov/dap/dap.min.js" async></script>

‎_includes/footer.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<footer role="contentinfo">
2+
<div class="wrap">
3+
<p>This project is maintained by <a href="{{ site.author.url }}">{{ site.author.name }}</a>.</p>
4+
5+
<p>Hosted on <a href="https://github.com/18F/pages/">18F Pages</a>.</p>
6+
<p><a href="{{ site.repos[0].url }}/edit/18f-pages/{{ page.path }}">Edit this page on GitHub</a></p>
7+
</div><!--/.wrap -->
8+
</footer>

‎_includes/header.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<head>
2+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
3+
<meta charset="utf-8">
4+
<title>{{ page.title }} - {{ site.name }}</title>
5+
<meta name="viewport" content="width=device-width">
6+
<link rel="shortcut icon" type="image/ico" href="{{ site.baseurl }}/images/favicons/favicon.ico" />
7+
<link rel="icon" type="image/png" href="{{ site.baseurl }}/images/favicons/favicon.png" />
8+
<link rel="apple-touch-icon-precomposed" href="{{ site.baseurl }}/images/favicons/18f-center-57.png">
9+
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="{{ site.baseurl }}/images/favicons/18f-center-72.png">
10+
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="{{ site.baseurl }}/images/favicons/18f-center-114.png">
11+
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/images/favicons/18f-center-144.png">
12+
<link rel="icon" type="image/png" sizes="192x192" href="{{ site.baseurl }}/images/favicons/18f-center-192.png" />
13+
<link href='//fonts.googleapis.com/css?family=Raleway:400,700%7COpen+Sans:300,600' rel='stylesheet' type='text/css'>
14+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
15+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/syntax.css">
16+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/custom.css">
17+
<!--[if lt IE 9]>
18+
<script src="{{ site.baseurl }}/assets/js/html5shiv.js"></script>
19+
<script src="{{ site.baseurl }}/assets/js/respond.js"></script>
20+
<![endif]-->
21+
</head>

‎_includes/scripts.html

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<script src="//code.jquery.com/jquery-1.11.2.min.js"></script>
2+
<script src="//code.jquery.com/jquery-migrate-1.2.1.min.js"></script>
3+
{% if page.title == "Keyboard Access" %}
4+
<script type="text/javascript">
5+
$(document).ready(function(){
6+
$('.moveFocus').on('focus',function(){
7+
$('.keyboardTrap:first').focus();
8+
});
9+
$('.keyboardTrap').click(function(){
10+
$('.moveFocus').each(function(){
11+
$(this).remove();
12+
});
13+
});
14+
});
15+
</script>
16+
{% endif %}
17+
18+
{% if page.title == "Flashing" %}
19+
<script type="text/javascript">
20+
$(document).ready(function(){
21+
var blinking = false,
22+
interval,
23+
$blink = $('.blink');
24+
$('#blinkbutton').click(function(){
25+
if (!blinking){
26+
$('#blinkbutton').html('Click to stop blinking');
27+
interval = setInterval(function(){
28+
$blink.toggle();
29+
},200);
30+
blinking = true;
31+
}
32+
else
33+
{
34+
clearInterval(interval);
35+
$('#blinkbutton').html('Click to see non-compliant flashing');
36+
$blink.hide();
37+
blinking = false;
38+
}
39+
});
40+
41+
});
42+
</script>
43+
{% endif %}
44+
{% if page.title == "Time Outs" %}
45+
<script type="text/javascript">
46+
$(document).ready(function(){
47+
var timer;
48+
$('#pForm input').on('input',function(){
49+
if (timer)
50+
clearTimeout(timer);
51+
timer = setTimeout(function(){
52+
var c = confirm('Would you like more time to complete the form?'),
53+
time;
54+
if(c == true)
55+
clearTimeout(timer);
56+
else
57+
$('#pForm').trigger('reset');
58+
}, 2000);
59+
});
60+
});
61+
</script>
62+
{% endif %}

0 commit comments

Comments
 (0)