Skip to content

Commit 516b312

Browse files
konklonekonklone
committed
some tidying - development config, readme instructions
some opengraph metadata, removed unused stuff
1 parent 26b1a67 commit 516b312

12 files changed

Lines changed: 95 additions & 110 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_site
2+
.DS_Store
3+

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ This is a collection of resources, best practices, and case studies for HTTPS in
55
Maintained by people from the [U.S. Digital Service](http://wh.gov/usds) and [18F](https://18f.gsa.gov). Please join us and help out!
66

77

8+
### Developing
9+
10+
To run the site in development, use both config files:
11+
12+
```
13+
jekyll serve --config _config.yml,_config-development.yml
14+
```
15+
816
### Public domain
917

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

‎_config-development.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
baseurl: ""

‎_config.yml‎

Lines changed: 26 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,49 @@
1-
# Base configuration
1+
# Override in development.
2+
baseurl: '/https'
3+
4+
exclude:
5+
- ".rbenv-version"
6+
- README.md
7+
- CONTRIBUTING.md
8+
- LICENSE.md
9+
10+
# markdown
11+
highlighter: pygments
12+
markdown: redcarpet
13+
redcarpet:
14+
extensions:
15+
- with_toc_data
16+
217
permalink: /:title
3-
exclude: [".rvmrc", ".rbenv-version", "README.md", "Rakefile", "changelog.md"]
4-
markdown: kramdown
5-
pygments: true
618

7-
# Title
19+
# Site metadata
820
name: HTTPS in Government
9-
subtitle: A resource for ensuring HTTPS on .gov websites
21+
subtitle: A resource for ensuring HTTPS on .gov websites.
22+
description: "Resources, best practices, and case studies for deploying HTTPS in the federal government."
1023

11-
#Edit Link info
24+
25+
# GitHub information
1226
repo_name: https
1327
branch: gh-pages
14-
#GitHub organization name *or* username
1528
gh_org: GSA
16-
prose_url: http://github.com/
1729
site_url: https://gsa.github.io/https
18-
media: assets/img
1930

20-
# When using this template with a project page set the baseurl to '/project-name'
21-
# For user/organization pages set this to an empty string
22-
# When working locally use jekyll serve --baseurl '' so that you can view everything at localhost:4000
23-
# See http://jekyllrb.com/docs/github-pages/ for more info
24-
#baseurl: ''
25-
baseurl: '/https'
26-
27-
# Author/Organization info to be displayed in the templates
28-
author:
29-
name: 18F
30-
url: https://18f.gsa.gov
31-
32-
# Point the logo URL at a file in your repo or hosted elsewhere by your organization
33-
logourl:
34-
logoalt:
31+
media: assets/img
3532

3633
# Navigation
3734
# List links that should appear in the site sidebar here
3835
navigation:
3936
- text: Home
40-
url: index.html
41-
internal: true
42-
- text: Background
43-
url: pages/background
37+
url: /
4438
internal: true
4539
- text: Definitions
46-
url: pages/definitions
47-
internal: true
48-
- text: Guidance
49-
url: pages/guidance
40+
url: /pages/definitions/
5041
internal: true
5142
- text: Tools
52-
url: pages/tools
43+
url: /pages/tools/
5344
internal: true
5445
- text: Resources
55-
url: pages/resources
56-
internal: true
57-
- text: Case Studies
58-
url: pages/case_studies
46+
url: /pages/resources/
5947
internal: true
6048

6149
# Style Variables

‎_includes/prose_edit_url.html‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎_includes/sidebar.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@
99
{% else %}
1010
<li><a href="{{ link.url }}">{{ link.text }}</a></li>
1111
{% endif %}
12-
{% endfor %}
13-
<!-- Edit This link -->
14-
<li>{% include prose_edit_url.html %}</li>
12+
{% endfor %}
1513
</ul>
1614
</nav>
1715
</aside>

‎_layouts/default.html‎

Lines changed: 53 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,57 @@
11
<!DOCTYPE html>
22
<html>
3-
<head>
4-
<meta http-equiv="X-UA-Compatible" content="IE=edge">
5-
<meta charset="utf-8">
3+
<head>
4+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
5+
<meta charset="utf-8">
6+
<meta name="viewport" content="width=device-width">
7+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/normalize.css">
8+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
9+
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/syntax.css">
10+
<!--[if lt IE 9]>
11+
<script src="https://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12+
<script src="{{ site.baseurl }}/assets/js/respond.min.js"></script>
13+
<![endif]-->
14+
15+
{% if page.title %}
616
<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="https://github.com//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="https://github.com/GSA/https">GitHub Pages</a>.</p>
43-
</div><!--/.wrap -->
44-
</footer>
45-
</div> <!-- /.container -->
46-
</body>
17+
<meta property="og:title" content="{{ page.title | xml_escape }}" />
18+
{% else %}
19+
<title>{{ site.title }}</title>
20+
<meta property="og:title" content="{{ site.title | xml_escape }}" />
21+
{% endif %}
22+
23+
{% if page.description %}
24+
<meta name="description" content="{{ page.description | xml_escape }}">
25+
<meta property="og:description" content="{{ page.description | xml_escape }}" />
26+
{% else %}
27+
<meta name="description" content="{{ site.description | xml_escape }}">
28+
<meta property="og:description" content="{{ site.description | xml_escape }}" />
29+
{% endif %}
30+
31+
</head>
32+
<body>
33+
34+
<div class="container">
35+
<header role="banner">
36+
<div class="wrap">
37+
<h1 class="site-title">
38+
<a class="title-link" href="{{ site.baseurl }}/">
39+
{{ site.name }}
40+
</a>
41+
</h1>
42+
</div>
43+
</header>
44+
45+
<div class="wrap content">
46+
47+
{% include sidebar.html %}
48+
49+
<section id="main" class="main-content" role="main">
50+
{{ content }}
51+
</section>
52+
53+
</div>
54+
</div>
55+
56+
</body>
4757
</html>

‎assets/img/octocat.png‎

-2 KB
Binary file not shown.

‎assets/img/screenshot.png‎

-79.4 KB
Binary file not shown.

‎pages/background.md‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)