Skip to content

Commit 1b071bd

Browse files
ProProgrammerProProgrammer
committed
Added script to copy files from poole submodule and copied files
The script is intended to be used each time poole submodule is updated with any relevant files
1 parent c9e30f1 commit 1b071bd

27 files changed

+991
-0
lines changed

‎404.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: default
3+
title: "404: Page not found"
4+
permalink: 404.html
5+
---
6+
7+
<div class="page">
8+
<h1 class="page-title">404: Page not found</h1>
9+
<p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{ site.baseurl }}/">Head back home</a> to try finding it again.</p>
10+
</div>

‎Gemfile‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
source "https://rubygems.org"
2+
3+
gem "jekyll"
4+
gem "jekyll-gist"
5+
gem "jekyll-paginate"
6+
gem "jekyll-seo-tag"

‎README.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Poole
2+
3+
*The Strange Case of Dr. Jekyll and Mr. Hyde* tells the story of a lawyer investigating the connection of two persons, Dr. Henry Jekyll and Mr. Edward Hyde. Chief among the novel's supporting cast is a man by the name of Mr. Poole, Dr. Jekyll's loyal butler.
4+
5+
-----
6+
7+
Poole is the butler for [Jekyll](http://jekyllrb.com), the static site generator. It's designed and developed by [@mdo](https://twitter.com/mdo) to provide a clear and concise foundational setup for any Jekyll site. It does so by furnishing a full vanilla Jekyll install with example templates, pages, posts, and styles.
8+
9+
![Poole](https://f.cloud.github.com/assets/98681/1834359/71ae4048-73db-11e3-9a3c-df38eb170537.png)
10+
11+
See Poole in action with [the demo site](https://demo.getpoole.com).
12+
13+
There are currently two official themes built on Poole:
14+
15+
* [Hyde](https://hyde.getpoole.com)
16+
* [Lanyon](https://lanyon.getpoole.com)
17+
18+
Individual theme feedback and bug reports should be submitted to the theme's individual repository.
19+
20+
21+
## Contents
22+
23+
- [Usage](#usage)
24+
- [Development](#development)
25+
- [Author](#author)
26+
- [License](#license)
27+
28+
29+
## Usage
30+
31+
### 1. Install dependencies
32+
33+
Poole is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem and related dependencies:
34+
35+
```bash
36+
$ gem install jekyll jekyll-gist jekyll-sitemap jekyll-seo-tag
37+
```
38+
39+
**Windows users:** Windows users have a bit more work to do, but luckily [@juthilo](https://github.com/juthilo) has your back with his [Run Jekyll on Windows](https://github.com/juthilo/run-jekyll-on-windows) guide.
40+
41+
**Need syntax highlighting?** Poole includes support for Pygments or Rouge, so install your gem of choice to make use of the built-in styling. Read more about this [in the Jekyll docs](http://jekyllrb.com/docs/templates/#code_snippet_highlighting).
42+
43+
### 2a. Quick start
44+
45+
To help anyone with any level of familiarity with Jekyll quickly get started, Poole includes everything you need for a basic Jekyll site. To that end, just download Poole and start up Jekyll.
46+
47+
### 2b. Roll your own Jekyll site
48+
49+
Folks wishing to use Jekyll's templates and styles can do so with a little bit of manual labor. Download Poole and then copy what you need (likely `_layouts/`, `*.html` files, `atom.xml` for RSS, and `assets/` for CSS, JS, etc.).
50+
51+
### 3. Running locally
52+
53+
To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/poole` (or whatever your Jekyll site's root directory is named):
54+
55+
```bash
56+
$ jekyll serve
57+
```
58+
59+
Open <http://localhost:4000> in your browser, and voilà.
60+
61+
### 4. Serving it up
62+
63+
If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.
64+
65+
1. Fork this repo and switch to the `gh-pages` branch.
66+
1. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain.
67+
2. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.**
68+
3. Done! Head to your GitHub Pages URL or custom domain.
69+
70+
No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site.
71+
72+
## Development
73+
74+
Poole has two branches, but only one is used for active development.
75+
76+
- `master` for development. **All pull requests should be to submitted against `master`.**
77+
- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.**
78+
79+
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in `_sass/`, included into `styles.scss`, and compile to `styles.css`.
80+
81+
## Author
82+
83+
**Mark Otto**
84+
- <https://github.com/mdo>
85+
- <https://twitter.com/mdo>
86+
87+
88+
## License
89+
90+
Open sourced under the [MIT license](LICENSE.md).
91+
92+
<3

‎_config.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Setup
2+
title: Poole
3+
tagline: The Jekyll Butler
4+
url: https://getpoole.com
5+
paginate: 1
6+
baseurl: ""
7+
permalink: pretty
8+
9+
# Gems
10+
plugins:
11+
- jekyll-gist
12+
- jekyll-paginate
13+
- jekyll-seo-tag
14+
15+
# Optimize Jekyll
16+
exclude:
17+
- .editorconfig
18+
- .git
19+
- .jekyll-cache
20+
- Gemfile
21+
- Gemfile.lock
22+
- LICENSE.md
23+
- README.md
24+
25+
sass:
26+
sass_dir: _sass
27+
style: :compressed
28+
29+
# Options
30+
31+
# Replace this value and uncomment to enable Google Analytics tracking
32+
# ga_analytics: UA-000000-0
33+
34+
# Specify the author for blog posts
35+
author:
36+
name: Mark Otto
37+
url: https://twitter.com/mdo
38+
email: markdotto@gmail.com
39+
40+
# Custom vars
41+
version: 3.0.0

‎_includes/head.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<head>
2+
<meta charset="UTF-8">
3+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
4+
5+
<title>
6+
{% if page.title == "Home" %}
7+
{{ site.title }}{% if site.tagline %} &middot; {{ site.tagline }}{% endif %}
8+
{% else %}
9+
{{ page.title }} &middot; {{ site.title }}
10+
{% endif %}
11+
</title>
12+
13+
<link rel="stylesheet" href="{{ 'styles.css' | relative_url }}">
14+
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ '/assets/apple-touch-icon-precomposed.png' | relative_url }}">
15+
<link rel="shortcut icon" href="{{ '/assets/favicon.ico' | relative_url }}">
16+
<link rel="alternate" type="application/atom+xml" title="{{ site.title }}" href="{{ 'atom.xml' | relative_url }}">
17+
18+
{% seo title=false %}
19+
</head>

‎_layouts/default.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!doctype html>
2+
<html lang="en">
3+
4+
{% include head.html %}
5+
6+
<body>
7+
8+
<div class="container content">
9+
<header class="masthead">
10+
<h3 class="masthead-title">
11+
<a href="{{ site.baseurl }}/" title="Home">{{ site.title }}</a>
12+
<small>{{ site.tagline }}</small>
13+
</h3>
14+
</header>
15+
16+
<main>
17+
{{ content }}
18+
</main>
19+
20+
<footer class="footer">
21+
<small>
22+
&copy; <time datetime="{{ site.time | date_to_xmlschema }}">{{ site.time | date: '%Y' }}</time>. All rights reserved.
23+
</small>
24+
</footer>
25+
</div>
26+
27+
{% if site.ga_analytics %}
28+
<script>
29+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
30+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
31+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
32+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
33+
ga('create', '{{ site.ga_analytics }}', 'auto');
34+
ga('send', 'pageview');
35+
</script>
36+
{% endif %}
37+
</body>
38+
</html>

‎_layouts/page.html‎

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

‎_layouts/post.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
layout: default
3+
---
4+
5+
<article class="post">
6+
<h1 class="post-title">{{ page.title }}</h1>
7+
<time datetime="{{ page.date | date_to_xmlschema }}" class="post-date">{{ page.date | date_to_string }}</time>
8+
{{ content }}
9+
</article>
10+
11+
{% if site.related_posts != empty %}
12+
<aside class="related">
13+
<h3>Related posts</h3>
14+
<ul class="related-posts">
15+
{% for post in site.related_posts limit:3 %}
16+
<li>
17+
<a href="{{ site.baseurl }}{{ post.url }}">
18+
{{ post.title }}
19+
<small><time datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date_to_string }}</time></small>
20+
</a>
21+
</li>
22+
{% endfor %}
23+
</ul>
24+
</aside>
25+
{% endif %}

‎_sass/_base.scss‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
// Body resets
2+
//
3+
// Update the foundational and global aspects of the page.
4+
5+
* {
6+
box-sizing: border-box;
7+
}
8+
9+
body {
10+
margin: 0;
11+
font-family: var(--body-font);
12+
font-size: var(--body-font-size);
13+
line-height: var(--body-line-height);
14+
color: var(--body-color);
15+
background-color: var(--body-bg);
16+
-webkit-text-size-adjust: 100%;
17+
-ms-text-size-adjust: 100%;
18+
}
19+
20+
// No `:visited` state is required by default (browsers will use `a`)
21+
a {
22+
color: var(--link-color);
23+
24+
// `:focus` is linked to `:hover` for basic accessibility
25+
&:hover,
26+
&:focus {
27+
color: var(--link-hover-color);
28+
}
29+
30+
strong {
31+
color: inherit;
32+
}
33+
}
34+
35+
img {
36+
display: block;
37+
max-width: 100%;
38+
margin-bottom: var(--spacer);
39+
border-radius: var(--border-radius);
40+
}
41+
42+
table {
43+
margin-bottom: 1rem;
44+
width: 100%;
45+
border: 0 solid var(--border-color);
46+
border-collapse: collapse;
47+
}
48+
49+
td,
50+
th {
51+
padding: .25rem .5rem;
52+
border-color: inherit;
53+
border-style: solid;
54+
border-width: 0;
55+
border-bottom-width: 1px;
56+
}
57+
58+
th {
59+
text-align: left;
60+
}
61+
62+
thead th {
63+
border-bottom-color: currentColor;
64+
}
65+
66+
mark {
67+
padding: .15rem;
68+
background-color: var(--yellow-100);
69+
border-radius: .125rem;
70+
}

‎_sass/_code.scss‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Code
2+
//
3+
// Inline and block-level code snippets. Includes tweaks to syntax highlighted
4+
// snippets from Pygments/Rouge and Gist embeds.
5+
6+
code,
7+
pre {
8+
font-family: var(--code-font);
9+
}
10+
11+
code {
12+
font-size: 85%;
13+
}
14+
15+
pre {
16+
display: block;
17+
margin-top: 0;
18+
margin-bottom: var(--spacer-3);
19+
overflow: auto;
20+
}
21+
22+
.highlight {
23+
padding: var(--spacer);
24+
margin-bottom: var(--spacer);
25+
background-color: var(--code-bg);
26+
border-radius: var(--border-radius);
27+
28+
pre {
29+
margin-bottom: 0;
30+
}
31+
32+
// Triple backticks (code fencing) doubles the .highlight elements
33+
.highlight {
34+
padding: 0;
35+
}
36+
}
37+
38+
.rouge-table {
39+
margin-bottom: 0;
40+
font-size: 100%;
41+
42+
&,
43+
td,
44+
th {
45+
border: 0;
46+
}
47+
48+
.gutter {
49+
vertical-align: top;
50+
user-select: none;
51+
opacity: .25;
52+
}
53+
}
54+
55+
// Gist via GitHub Pages
56+
.gist .markdown-body {
57+
padding: 15px !important;
58+
}

0 commit comments

Comments
 (0)