adding site · GSA/https@6976335 · GitHub
Skip to content

Commit 6976335

Browse files
committed
adding site
1 parent a529320 commit 6976335

19 files changed

Lines changed: 1430 additions & 0 deletions

‎CONTRIBUTING.md‎

Lines changed: 20 additions & 0 deletions

‎COPYING.txt‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

‎README 2.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# DOCter
2+
3+
DOCter is a [Jekyll](http://jekyllrb.com/) template for quickly building out project pages and documentation.
4+
5+
![DOCter Screenshot](https://github.com/ascott1/DOCter/blob/gh-pages/assets/img/screenshot.png?raw=true)
6+
7+
[See the demo](http://cfpb.github.io/DOCter/)
8+
9+
## To run DOCter locally
10+
11+
Be sure to have Jekyll and Kramdown installed.
12+
13+
```
14+
gem install jekyll
15+
gem install kramdown
16+
```
17+
18+
Fork and clone the repo:
19+
20+
```
21+
git clone git@github.com:ascott1/DOCter.git
22+
cd DOCter
23+
```
24+
Run Jekyll:
25+
26+
```
27+
jekyll serve --baseurl ''
28+
```
29+
30+
31+
## _config.yml
32+
33+
Options within the `_config.yml` file allow you to control the site's title, subtitle, logo, author information, and the left column navigation.
34+
35+
36+
### Project Page URL Structure
37+
38+
**This is an excerpt from the [Jekyll docs](http://jekyllrb.com/docs/github-pages/) on configuring your URL for Project Pages.**
39+
40+
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages` branch to GitHub. However, the subdirectory-like URL structure GitHub uses for Project Pages complicates the proper resolution of URLs. Here is an approach to utilizing the GitHub Project Page URL structure (`username.github.io/project-name/`) whilst maintaining the ability to preview your Jekyll site locally.
41+
42+
1. In `_config.yml`, set the `baseurl` option to `/project-name` -- note the leading slash and the **absence** of a trailing slash.
43+
2. When referencing JS or CSS files, do it like this: `{{ site.baseurl }}/path/to/css.css` -- note the slash immediately following the variable (just before "path").
44+
3. When doing permalinks or internal links, do it like this: `{{ site.baseurl }}{{ post.url }}` -- note that there is **no** slash between the two variables.
45+
4. Finally, if you'd like to preview your site before committing/deploying using `jekyll serve`, be sure to pass an **empty string** to the `--baseurl` option, so that you can view everything at `localhost:4000` normally (without `/project-name` at the beginning): `jekyll serve --baseurl ''`
46+
47+
This way, you can preview your site locally from the site root on localhost, but when GitHub generates your pages from the gh-pages branch all the URLs will start with `/project-name` and resolve properly.
48+
49+
## License
50+
51+
The project is in the public domain, and all contributions to it will be released as such. By submitting a pull request, you are agreeing to waive all rights to your contribution under the terms of the [CC0 Public Domain Dedication](http://creativecommons.org/publicdomain/zero/1.0/).
52+
53+
If you contribute the open source work of others, please mark it clearly in your pull request.

‎TERMS.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
As a work of the United States Government, this package is in the
2+
public domain within the United States. Additionally, we waive
3+
copyright and related rights in the work worldwide through the CC0 1.0
4+
Universal public domain dedication.
5+
6+
Software source code previously released under an open source license and then
7+
modified by CFPB staff is considered a "joint work" (see 17 USC § 101); it is
8+
partially copyrighted, partially public domain, and as a whole is protected by
9+
the copyrights of the non-government authors and must be released according to
10+
the terms of the original open-source license.
11+
12+
For further details, please see the CFPB [Source Code Policy][policy].
13+
14+
15+
## CC0 1.0 Universal Summary
16+
17+
This is a human-readable summary of the [Legal Code (read the full text)][CC0].
18+
19+
### No Copyright
20+
21+
The person who associated a work with this deed has dedicated the work to
22+
the public domain by waiving all of his or her rights to the work worldwide
23+
under copyright law, including all related and neighboring rights, to the
24+
extent allowed by law.
25+
26+
You can copy, modify, distribute and perform the work, even for commercial
27+
purposes, all without asking permission. See Other Information below.
28+
29+
### Other Information
30+
31+
In no way are the patent or trademark rights of any person affected by CC0,
32+
nor are the rights that other persons may have in the work or in how the
33+
work is used, such as publicity or privacy rights.
34+
35+
Unless expressly stated otherwise, the person who associated a work with
36+
this deed makes no warranties about the work, and disclaims liability for
37+
all uses of the work, to the fullest extent permitted by applicable law.
38+
When using or citing the work, you should not imply endorsement by the
39+
author or the affirmer.
40+
41+
[policy]: http://github.com/cfpb/source-code-policy/
42+
[CC0]: http://creativecommons.org/publicdomain/zero/1.0/legalcode
43+
44+
## This project makes use of:
45+
46+
* [Respond.js](https://github.com/scottjehl/Respond) by Scott Jehl, licensed under the MIT license.
47+
* [The HTML5 Shiv](https://github.com/aFarkas/html5shiv), dual licensed under the MIT or GPL Version 2 licenses.
48+
*

‎_config.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Base configuration
2+
permalink: /:title
3+
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
4+
markdown: kramdown
5+
pygments: true
6+
7+
# Title
8+
name: DOCter
9+
subtitle: A Jekyll template for project documentation
10+
11+
# When using this template with a project page set the baseurl to '/project-name'
12+
# For user/organization pages set this to an empty string
13+
# When working locally use jekyll serve --baseurl '' so that you can view everything at localhost:4000
14+
# See http://jekyllrb.com/docs/github-pages/ for more info
15+
#baseurl: ''
16+
baseurl: '/DOCter'
17+
18+
# Author/Organization info to be displayed in the templates
19+
author:
20+
name: Name
21+
url: http://localhost:4000
22+
23+
# Point the logo URL at a file in your repo or hosted elsewhere by your organization
24+
logourl:
25+
logoalt:
26+
27+
# Navigation
28+
# List links that should appear in the site sidebar here
29+
navigation:
30+
- text: Home
31+
url: index.html
32+
internal: true
33+
- text: Example Page
34+
url: example_page.html
35+
internal: true
36+
- text: DOCter Repo
37+
url: https://github.com/cfpb/DOCter
38+
internal: false
39+
40+
# Repo list
41+
# List repos that you would like to appear on the homepage here
42+
repos:
43+
- name: DOCter
44+
description: Jekyll template for docs
45+
url: https://github.com/cfpb/DOCter
46+
47+
# Style Variables
48+
brand_color: "#2cb34a"

‎_includes/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
The homepage content can be edited as markdown in _includes/index.html or directly within the index.html file.
2+
3+
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

‎_includes/sidebar.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<aside>
2+
<p class="intro">{{ site.subtitle }}</p>
3+
<a class="skip-link visuallyhidden focusable" href="#main">Skip to Main Content</a>
4+
<nav class="sidebar-nav" role="navigation">
5+
<ul>
6+
{% for link in site.navigation %}
7+
{% if link.internal == true %}
8+
<li><a href="{{ site.baseurl }}/{{ link.url }}">{{ link.text }}</a></li>
9+
{% else %}
10+
<li><a href="{{ link.url }}">{{ link.text }}</a></li>
11+
{% endif %}
12+
{% endfor %}
13+
</ul>
14+
</nav>
15+
</aside>

‎_layouts/default.html‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
5+
<meta charset="utf-8">
6+
<title>{{ page.title }}</title>
7+
<meta name="viewport" content="width=device-width">
8+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/normalize.css">
9+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
10+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/syntax.css">
11+
<!--[if lt IE 9]>
12+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13+
<script src="{{ site.baseurl }}/assets/js/respond.min.js"></script>
14+
<![endif]-->
15+
16+
</head>
17+
<body>
18+
<div class="container">
19+
<header role="banner">
20+
<div class="wrap">
21+
{% if site.logourl != null %}
22+
<img class="logo" src="{{ site.logourl }}" alt="{{ site.logoalt }}">
23+
{% endif %}
24+
<h1 class="site-title"><a class="title-link" href="{{ site.baseurl }}/">{{ site.name }}</a></h1>
25+
</div>
26+
</header>
27+
28+
<div class="wrap content">
29+
30+
{% include sidebar.html %}
31+
32+
<section id="main" class="main-content" role="main">
33+
{{ content }}
34+
</section>
35+
36+
</div><!-- /.wrap content -->
37+
38+
<footer role="contentinfo">
39+
<div class="wrap">
40+
<p>This project is maintained by <a href="{{ site.author.url }}">{{ site.author.name }}</a>.</p>
41+
42+
<p>Hosted on <a href="http://pages.github.com/">GitHub Pages</a>.</p>
43+
</div><!--/.wrap -->
44+
</footer>
45+
</div> <!-- /.container -->
46+
</body>
47+
</html>

‎_layouts/page.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: default
3+
---
4+
<h2 class="page-title">{{ page.title }}</h2>
5+
6+
{{ content }}

‎_layouts/post.html‎

Lines changed: 11 additions & 0 deletions

0 commit comments

Comments
 (0)