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

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Melody Kramer committed Jul 27, 2015
0 parents commit e5b8f13
Show file tree
Hide file tree
Showing 80 changed files with 4,827 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

gem 'jekyll'
gem 'rouge'
72 changes: 72 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
GEM
remote: https://rubygems.org/
specs:
blankslate (2.1.2.4)
celluloid (0.16.0)
timers (~> 4.0.0)
classifier-reborn (2.0.3)
fast-stemmer (~> 1.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.9.1.1)
colorator (0.1)
execjs (2.5.2)
fast-stemmer (1.0.2)
ffi (1.9.9)
hitimes (1.2.2)
jekyll (2.5.3)
classifier-reborn (~> 2.0)
colorator (~> 0.1)
jekyll-coffeescript (~> 1.0)
jekyll-gist (~> 1.0)
jekyll-paginate (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 2.6.1)
mercenary (~> 0.3.3)
pygments.rb (~> 0.6.0)
redcarpet (~> 3.1)
safe_yaml (~> 1.0)
toml (~> 0.1.0)
jekyll-coffeescript (1.0.1)
coffee-script (~> 2.2)
jekyll-gist (1.2.1)
jekyll-paginate (1.1.0)
jekyll-sass-converter (1.3.0)
sass (~> 3.2)
jekyll-watch (1.2.1)
listen (~> 2.7)
kramdown (1.7.0)
liquid (2.6.2)
listen (2.10.1)
celluloid (~> 0.16.0)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
mercenary (0.3.5)
parslet (1.5.0)
blankslate (~> 2.0)
posix-spawn (0.3.11)
pygments.rb (0.6.3)
posix-spawn (~> 0.3.6)
yajl-ruby (~> 1.2.0)
rb-fsevent (0.9.5)
rb-inotify (0.9.5)
ffi (>= 0.5.0)
redcarpet (3.3.2)
rouge (1.9.0)
safe_yaml (1.0.4)
sass (3.4.15)
timers (4.0.1)
hitimes
toml (0.1.2)
parslet (~> 1.5.0)
yajl-ruby (1.2.1)

PLATFORMS
ruby

DEPENDENCIES
jekyll
rouge
32 changes: 32 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
As a work of the United States Government, this project is in the
public domain within the United States.

Additionally, we waive copyright and related rights in the work
worldwide through the CC0 1.0 Universal public domain dedication.

## CC0 1.0 Universal Summary

This is a human-readable summary of the
[Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).

### No Copyright

The person who associated a work with this deed has dedicated the work to
the public domain by waiving all of his or her rights to the work worldwide
under copyright law, including all related and neighboring rights, to the
extent allowed by law.

You can copy, modify, distribute and perform the work, even for commercial
purposes, all without asking permission.

### Other Information

In no way are the patent or trademark rights of any person affected by CC0,
nor are the rights that other persons may have in the work or in how the
work is used, such as publicity or privacy rights.

Unless expressly stated otherwise, the person who associated a work with
this deed makes no warranties about the work, and disclaims liability for
all uses of the work, to the fullest extent permitted by applicable law.
When using or citing the work, you should not imply endorsement by the
author or the affirmer.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
## 18F Guides Template

This is a skeleton repo containing the
[CFPB/DOCter](https://github.com/CFPB/DOCter)-based
[Jekyll](http://jekyllrb.com/) template for
[18F Guides](http://18f.github.io/guides/).

### Generating the site/hosting locally

You will need [Ruby](https://www.ruby-lang.org) ( > version 2.1.5 ). You may
consider using a Ruby version manager such as
[rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) to
help ensure that Ruby version upgrades don't mean all your
[gems](https://rubygems.org/) will need to be rebuilt.

On OS X, you can use [Homebrew](http://brew.sh/) to install Ruby in
`/usr/local/bin`, which may require you to update your `$PATH` environment
variable:

```shell
$ brew update
$ brew install ruby
```

To create a new guide and serve it locally, where `MY-NEW-GUIDE` is the name
of your new repository:

```shell
$ git clone git@github.com:18F/guides-template.git MY-NEW-GUIDE
$ cd MY-NEW-GUIDE
$ ./go init
$ ./go serve
```

This will check that your Ruby version is supported, install the [Bundler
gem](http://bundler.io/) if it is not yet installed, install all the gems
needed by the template, and launch a running instance on
`http://localhost:4000/guides-template/`. (Make sure to include the trailing slash! The built-in
Jekyll webserver doesn't redirect to it.) That page contains further
instructions on how to adapt the template to a new guide repository.

After going through these steps, run `./go` to see a list of available
commands. The `serve` command is the most common for routine development.

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".

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.

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.
```
git remote set-url origin https://github.com/18F/MY-NEW-GUIDE.git
git push origin 18f-pages
```

Now you can edit the template freely, and push up changes as you need.

### Staging version

You can create an `18f-pages-staging` branch and changes to that branch will
be published to `https://pages.18f.gov/staging/MY-NEW-GUIDE`.

TODO(mbland): Finish

### Public domain

This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):

> 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/).
>
> 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.
# open-source-guide
57 changes: 57 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
baseurl: /open-source-guide
markdown: redcarpet
name: 18F Open Source Style Guide
exclude:
- go
- copy-template
- Gemfile
- Gemfile.lock
- README.md
- LICENSE.md

permalink: pretty
highlighter: rouge

# Author/Organization info to be displayed in the templates
author:
name: 18F
url: https://18f.gsa.gov

# Point the logo URL at a file in your repo or hosted elsewhere by your organization
logourl: /assets/img/18f-logo.png
logoalt: 18F logo

# Navigation
# List links that should appear in the site sidebar here
navigation:
- text: Introduction
url: index.html
internal: true
- text: Naming Your Project
url: naming-your-project/
internal: true
- text: Writing The Repo Description
url: writing-the-repo-description/
internal: true
- text: Making READMEs readable
url: making-readmes-readable/
internal: true
- text: Writing Clear and Concise Issues
url: writing-clear-and-concise-issues/
internal: true
- text: Best Practices For Using the Wiki
url: using-the-wiki/
internal: true
- text: GitHub Repo Checklist
url: github-repo-checklist/
internal: true

repos:
- name: 18F Open Source Style Guide
description: Main repository
url: https://github.com/18F/open-source-guide

# Style Variables
brand_color: "#1188ff"

google_analytics_ua: UA-48605964-19
16 changes: 16 additions & 0 deletions _includes/analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google_analytics_ua }}', 'gsa.gov');

// anonymize user IPs (chops off the last IP triplet)
ga('set', 'anonymizeIp', true);

ga('send', 'pageview');
</script>

<!-- Digital Analytics Program roll-up, see https://analytics.usa.gov for data -->
<script id="_fed_an_ua_tag" src="https://analytics.usa.gov/dap/dap.min.js" async></script>
8 changes: 8 additions & 0 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<footer role="contentinfo">
<div class="wrap">
<p>This project is maintained by <a href="{{ site.author.url }}">{{ site.author.name }}</a>.</p>

<p>Hosted on <a href="https://github.com/18F/pages/">18F Pages</a>.</p>
<p><a href="{{ site.repos[0].url }}/edit/18f-pages/{{ page.path }}">Edit this page on GitHub</a></p>
</div><!--/.wrap -->
</footer>
21 changes: 21 additions & 0 deletions _includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta charset="utf-8">
<title>{{ page.title }} - {{ site.name }}</title>
<meta name="viewport" content="width=device-width">
<link rel="shortcut icon" type="image/ico" href="{{ site.baseurl }}/images/favicons/favicon.ico" />
<link rel="icon" type="image/png" href="{{ site.baseurl }}/images/favicons/favicon.png" />
<link rel="apple-touch-icon-precomposed" href="{{ site.baseurl }}/images/favicons/18f-center-57.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="{{ site.baseurl }}/images/favicons/18f-center-72.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="{{ site.baseurl }}/images/favicons/18f-center-114.png">
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}/images/favicons/18f-center-144.png">
<link rel="icon" type="image/png" sizes="192x192" href="{{ site.baseurl }}/images/favicons/18f-center-192.png" />
<link href='//fonts.googleapis.com/css?family=Raleway:400,700%7COpen+Sans:300,600' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/syntax.css">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/custom.css">
<!--[if lt IE 9]>
<script src="{{ site.baseurl }}/assets/js/html5shiv.js"></script>
<script src="{{ site.baseurl }}/assets/js/respond.js"></script>
<![endif]-->
</head>
62 changes: 62 additions & 0 deletions _includes/scripts.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<script src="//code.jquery.com/jquery-1.11.2.min.js"></script>
<script src="//code.jquery.com/jquery-migrate-1.2.1.min.js"></script>
{% if page.title == "Keyboard Access" %}
<script type="text/javascript">
$(document).ready(function(){
$('.moveFocus').on('focus',function(){
$('.keyboardTrap:first').focus();
});
$('.keyboardTrap').click(function(){
$('.moveFocus').each(function(){
$(this).remove();
});
});
});
</script>
{% endif %}

{% if page.title == "Flashing" %}
<script type="text/javascript">
$(document).ready(function(){
var blinking = false,
interval,
$blink = $('.blink');
$('#blinkbutton').click(function(){
if (!blinking){
$('#blinkbutton').html('Click to stop blinking');
interval = setInterval(function(){
$blink.toggle();
},200);
blinking = true;
}
else
{
clearInterval(interval);
$('#blinkbutton').html('Click to see non-compliant flashing');
$blink.hide();
blinking = false;
}
});

});
</script>
{% endif %}
{% if page.title == "Time Outs" %}
<script type="text/javascript">
$(document).ready(function(){
var timer;
$('#pForm input').on('input',function(){
if (timer)
clearTimeout(timer);
timer = setTimeout(function(){
var c = confirm('Would you like more time to complete the form?'),
time;
if(c == true)
clearTimeout(timer);
else
$('#pForm').trigger('reset');
}, 2000);
});
});
</script>
{% endif %}
Loading

0 comments on commit e5b8f13

Please sign in to comment.