Skip to content

Commit 7be902b

Browse files
author
Mike Churchward
committed
Adding Jekyll Now theme to git pages.
1 parent 583d110 commit 7be902b

27 files changed

+903
-3
lines changed

‎404.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
layout: page
3+
title: 404 - Page not found
4+
---
5+
6+
Sorry, we can't find that page that you're looking for. You can try again by going [back to the homepage]({{ site.baseurl }}/).
7+
8+
[<img src="{{ site.baseurl }}/images/404.jpg" alt="Constructocat by https://github.com/jasoncostello" style="width: 400px;"/>]({{ site.baseurl }}/)

‎CNAME

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015 Barry Clark
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

100644100755
+120-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,120 @@
1-
# PoetOS.github.io
2-
Github pages for Poet.
1+
> March, 2016: If you're on an old version of Jekyll Now and run into a) build warnings or b) syntax highlighting issues caused by [Jekyll 3 and GitHub Pages updates](https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0), just :sparkles:[update your _config.yml](https://github.com/barryclark/jekyll-now/pull/445/files):sparkles: and you'll be set!
2+
3+
# Jekyll Now
4+
5+
**Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll))
6+
7+
**Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.
8+
9+
- You don't need to touch the command line
10+
- You don't need to install/configure ruby, rvm/rbenv, ruby gems :relaxed:
11+
- You don't need to install runtime dependencies like markdown processors, Pygments, etc
12+
- If you're on Windows, this will make setting up Jekyll a lot easier
13+
- It's easy to try out, you can just delete your forked repository if you don't like it
14+
15+
In a few minutes you'll be set up with a minimal, responsive blog like the one below giving you more time to spend on writing epic blog posts!
16+
17+
![Jekyll Now Theme Screenshot](/images/jekyll-now-theme-screenshot.jpg "Jekyll Now Theme Screenshot")
18+
19+
## Quick Start
20+
21+
### Step 1) Fork Jekyll Now to your User Repository
22+
23+
Fork this repo, then rename the repository to yourgithubusername.github.io.
24+
25+
Your Jekyll blog will often be viewable immediately at <http://yourgithubusername.github.io> (if it's not, you can often force it to build by completing step 2)
26+
27+
![Step 1](/images/step1.gif "Step 1")
28+
29+
### Step 2) Customize and view your site
30+
31+
Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.
32+
33+
Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <http://yourgithubusername.github.io> - if not, give it ten minutes as GitHub suggests and it'll appear soon
34+
35+
> There are 3 different ways that you can make changes to your blog's files:
36+
37+
> 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
38+
> 2. Use a third party GitHub content editor, like [Prose by Development Seed](http://prose.io). It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
39+
> 3. Clone down your repository and make updates locally, then push them to your GitHub repository.
40+
41+
![_config.yml](/images/config.png "_config.yml")
42+
43+
### Step 3) Publish your first blog post
44+
45+
Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Markdown Cheatsheet](http://www.jekyllnow.com/Markdown-Style-Guide/) might come in handy.
46+
47+
![First Post](/images/first-post.png "First Post")
48+
49+
> You can add additional posts in the browser on GitHub.com too! Just hit the + icon in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md
50+
51+
## Local Development
52+
53+
1. Install Jekyll and plug-ins in one fell swoop. `gem install github-pages` This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
54+
2. Clone down your fork `git clone https://github.com/yourusername/yourusername.github.io.git`
55+
3. Serve the site and watch for markup/sass changes `jekyll serve`
56+
4. View your website at http://127.0.0.1:4000/
57+
5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.
58+
59+
## Moar!
60+
61+
I've created a more detailed walkthrough, [**Build A Blog With Jekyll And GitHub Pages**](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/) over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll. :metal:
62+
63+
It covers:
64+
65+
- A more detailed walkthrough of setting up your Jekyll blog
66+
- Common issues that you might encounter while using Jekyll
67+
- Importing from Wordpress, using your own domain name, and blogging in your favorite editor
68+
- Theming in Jekyll, with Liquid templating examples
69+
- A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections
70+
71+
## Jekyll Now Features
72+
73+
✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog
74+
✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)
75+
✓ Sass/Coffeescript support using Jekyll 2.0
76+
✓ Free hosting on your GitHub Pages user site
77+
✓ Markdown blogging
78+
✓ Syntax highlighting
79+
✓ Disqus commenting
80+
✓ Google Analytics integration
81+
✓ SVG social icons for your footer
82+
✓ 3 http requests, including your avatar
83+
84+
✘ No installing dependencies
85+
✘ No need to set up local development
86+
✘ No configuring plugins
87+
✘ No need to spend time on theming
88+
✘ More time to code other things ... wait ✓!
89+
90+
## Questions?
91+
92+
[Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat!
93+
94+
## Other forkable themes
95+
96+
You can use the [Quick Start](https://github.com/barryclark/jekyll-now#quick-start) workflow with other themes that are set up to be forked too! Here are some of my favorites:
97+
98+
- [Hyde](https://github.com/poole/hyde) by MDO
99+
- [Lanyon](https://github.com/poole/lanyon) by MDO
100+
- [mojombo.github.io](https://github.com/mojombo/mojombo.github.io) by Tom Preston-Werner
101+
- [Left](https://github.com/holman/left) by Zach Holman
102+
- [Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes) by Michael Rose
103+
- [Skinny Bones](https://github.com/mmistakes/skinny-bones-jekyll) by Michael Rose
104+
105+
## Credits
106+
107+
- [Jekyll](https://github.com/jekyll/jekyll) - Thanks to its creators, contributors and maintainers.
108+
- [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel. They're beautiful.
109+
- [Solarized Light Pygments](https://gist.github.com/edwardhotchkiss/2005058) - Thanks, Edward.
110+
- [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml in this repository.
111+
- [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy), [Luke Patton](https://github.com/lkpttn) - Thanks for the design/code reviews.
112+
- [Bart Kiers](https://github.com/bkiers), [Florian Simon](https://github.com/vermluh), [Henry Stanley](https://github.com/henryaj), [Hun Jae Lee](https://github.com/hunjaelee), [Javier Cejudo](https://github.com/javiercejudo), [Peter Etelej](https://github.com/etelej), [Ben Abbott](https://github.com/jaminscript), [Ray Nicholus](https://github.com/rnicholus), [Erin Grand](https://github.com/eringrand), [Léo Colombaro](https://github.com/LeoColomb), [Dean Attali](https://github.com/daattali), [Clayton Errington](https://github.com/cjerrington), [Colton Fitzgerald](https://github.com/coltonfitzgerald), [Trace Mayer](https://github.com/sunnankar) - Thanks for your [fantastic contributions](https://github.com/barryclark/jekyll-now/commits/master) to the project!
113+
114+
## Contributing
115+
116+
Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.
117+
118+
You can start by [opening an issue](https://github.com/barryclark/jekyll-now/issues/new) describing the problem that you're looking to resolve and we'll go from there.
119+
120+
I want to keep Jekyll Now as minimal as possible. Every line of code should be one that's useful to 90% of the people using it. Please bear that in mind when submitting feature requests. If it's not something that most people will use, it probably won't get merged. :guardsman:

‎_config.yml

100644100755
+86-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,86 @@
1-
theme: jekyll-theme-minimal
1+
#
2+
# This file contains configuration flags to customize your site
3+
#
4+
5+
# Name of your site (displayed in the header)
6+
name: Poet Open Source Community Portal
7+
8+
# Short bio or description (displayed in the header)
9+
description: To collaborate and report on all of Poet's activities.
10+
11+
# URL of your avatar or profile pic (you could use your GitHub profile pic)
12+
avatar: https://avatars2.githubusercontent.com/u/15897440?v=3&s=200
13+
14+
#
15+
# Flags below are optional
16+
#
17+
18+
# Includes an icon in the footer for each username you enter
19+
footer-links:
20+
dribbble:
21+
email:
22+
facebook:
23+
flickr:
24+
github: PoetOS
25+
instagram:
26+
linkedin:
27+
pinterest:
28+
rss: # just type anything here for a working RSS icon
29+
twitter: poetopensource
30+
stackoverflow: # your stackoverflow profile, e.g. "users/50476/bart-kiers"
31+
youtube: # channel/<your_long_string> or user/<user-name>
32+
googleplus: # anything in your profile username that comes after plus.google.com/
33+
34+
35+
# Enter your Disqus shortname (not your username) to enable commenting on posts
36+
# You can find your shortname on the Settings page of your Disqus account
37+
disqus:
38+
39+
# Enter your Google Analytics web tracking code (e.g. UA-2110908-2) to activate tracking
40+
google_analytics:
41+
42+
# Your website URL (e.g. http://barryclark.github.io or http://www.barryclark.co)
43+
# Used for Sitemap.xml and your RSS feed
44+
url: https://poetos.github.io
45+
46+
# If you're hosting your site at a Project repository on GitHub pages
47+
# (http://yourusername.github.io/repository-name)
48+
# and NOT your User repository (http://yourusername.github.io)
49+
# then add in the baseurl here, like this: "/repository-name"
50+
baseurl: ""
51+
52+
#
53+
# !! You don't need to change any of the configuration flags below !!
54+
#
55+
56+
permalink: /:title/
57+
58+
# The release of Jekyll Now that you're using
59+
version: v1.2.0
60+
61+
# Jekyll 3 now only supports Kramdown for Markdown
62+
kramdown:
63+
# Use GitHub flavored markdown, including triple backtick fenced code blocks
64+
input: GFM
65+
# Jekyll 3 and GitHub Pages now only support rouge for syntax highlighting
66+
syntax_highlighter: rouge
67+
syntax_highlighter_opts:
68+
# Use existing pygments syntax highlighting css
69+
css_class: 'highlight'
70+
71+
# Set the Sass partials directory, as we're using @imports
72+
sass:
73+
style: :expanded # You might prefer to minify using :compressed
74+
75+
# Use the following plug-ins
76+
gems:
77+
- jekyll-sitemap # Create a sitemap using the official Jekyll sitemap gem
78+
- jekyll-feed # Create an Atom feed using the official Jekyll feed gem
79+
80+
# Exclude these files from your production _site
81+
exclude:
82+
- Gemfile
83+
- Gemfile.lock
84+
- LICENSE
85+
- README.md
86+
- CNAME

‎_includes/analytics.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{% if site.google_analytics %}
2+
<!-- Google Analytics -->
3+
<script>
4+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
5+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
6+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
7+
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
8+
9+
ga('create', '{{ site.google_analytics }}', 'auto');
10+
ga('send', 'pageview', {
11+
'page': '{{ site.baseurl }}{{ page.url }}',
12+
'title': '{{ page.title | replace: "'", "\\'" }}'
13+
});
14+
</script>
15+
<!-- End Google Analytics -->
16+
{% endif %}

‎_includes/disqus.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{% if site.disqus %}
2+
<div class="comments">
3+
<div id="disqus_thread"></div>
4+
<script type="text/javascript">
5+
6+
var disqus_shortname = '{{ site.disqus }}';
7+
8+
(function() {
9+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
10+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
11+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
12+
})();
13+
14+
</script>
15+
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
16+
</div>
17+
{% endif %}

‎_includes/meta.html

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<meta charset="utf-8" />
2+
<meta content='text/html; charset=utf-8' http-equiv='Content-Type'>
3+
<meta http-equiv='X-UA-Compatible' content='IE=edge'>
4+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1.0'>
5+
6+
{% if page.excerpt %}
7+
<meta name="description" content="{{ page.excerpt| strip_html }}" />
8+
<meta property="og:description" content="{{ page.excerpt| strip_html }}" />
9+
{% else %}
10+
<meta name="description" content="{{ site.description }}">
11+
<meta property="og:description" content="{{ site.description }}" />
12+
{% endif %}
13+
<meta name="author" content="{{ site.name }}" />
14+
15+
{% if page.title %}
16+
<meta property="og:title" content="{{ page.title }}" />
17+
<meta property="twitter:title" content="{{ page.title }}" />
18+
{% endif %}

‎_includes/svg-icons.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{% if site.footer-links.dribbble %}<a href="https://dribbble.com/{{ site.footer-links.dribbble }}"><i class="svg-icon dribbble"></i></a>{% endif %}
2+
{% if site.footer-links.email %}<a href="mailto:{{ site.footer-links.email }}"><i class="svg-icon email"></i></a>{% endif %}
3+
{% if site.footer-links.facebook %}<a href="https://www.facebook.com/{{ site.footer-links.facebook }}"><i class="svg-icon facebook"></i></a>{% endif %}
4+
{% if site.footer-links.flickr %}<a href="https://www.flickr.com/{{ site.footer-links.flickr }}"><i class="svg-icon flickr"></i></a>{% endif %}
5+
{% if site.footer-links.github %}<a href="https://github.com/{{ site.footer-links.github }}"><i class="svg-icon github"></i></a>{% endif %}
6+
{% if site.footer-links.instagram %}<a href="https://instagram.com/{{ site.footer-links.instagram }}"><i class="svg-icon instagram"></i></a>{% endif %}
7+
{% if site.footer-links.linkedin %}<a href="https://www.linkedin.com/in/{{ site.footer-links.linkedin }}"><i class="svg-icon linkedin"></i></a>{% endif %}
8+
{% if site.footer-links.pinterest %}<a href="https://www.pinterest.com/{{ site.footer-links.pinterest }}"><i class="svg-icon pinterest"></i></a>{% endif %}
9+
{% if site.footer-links.rss %}<a href="{{ site.baseurl }}/feed.xml"><i class="svg-icon rss"></i></a>{% endif %}
10+
{% if site.footer-links.twitter %}<a href="https://www.twitter.com/{{ site.footer-links.twitter }}"><i class="svg-icon twitter"></i></a>{% endif %}
11+
{% if site.footer-links.stackoverflow %}<a href="http://stackoverflow.com/{{ site.footer-links.stackoverflow }}"><i class="svg-icon stackoverflow"></i></a>{% endif %}
12+
{% if site.footer-links.youtube %}<a href="https://youtube.com/{{ site.footer-links.youtube }}"><i class="svg-icon youtube"></i></a>{% endif %}
13+
{% if site.footer-links.googleplus %}<a href="https://plus.google.com/{{ site.footer-links.googleplus }}"><i class="svg-icon googleplus"></i></a>{% endif %}

‎_layouts/default.html

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>{% if page.title %}{{ page.title }} – {% endif %}{{ site.name }} – {{ site.description }}</title>
5+
6+
{% include meta.html %}
7+
8+
<!--[if lt IE 9]>
9+
<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
10+
<![endif]-->
11+
12+
<link rel="stylesheet" type="text/css" href="{{ site.baseurl }}/style.css" />
13+
<link rel="alternate" type="application/rss+xml" title="{{ site.name }} - {{ site.description }}" href="{{ site.baseurl }}/feed.xml" />
14+
15+
<!-- Created with Jekyll Now - http://github.com/barryclark/jekyll-now -->
16+
</head>
17+
18+
<body>
19+
<div class="wrapper-masthead">
20+
<div class="container">
21+
<header class="masthead clearfix">
22+
<a href="{{ site.baseurl }}/" class="site-avatar"><img src="{{ site.avatar }}" /></a>
23+
24+
<div class="site-info">
25+
<h1 class="site-name"><a href="{{ site.baseurl }}/">{{ site.name }}</a></h1>
26+
<p class="site-description">{{ site.description }}</p>
27+
</div>
28+
29+
<nav>
30+
<a href="{{ site.baseurl }}/">Blog</a>
31+
<a href="{{ site.baseurl }}/about">About</a>
32+
</nav>
33+
</header>
34+
</div>
35+
</div>
36+
37+
<div id="main" role="main" class="container">
38+
{{ content }}
39+
</div>
40+
41+
<div class="wrapper-footer">
42+
<div class="container">
43+
<footer class="footer">
44+
{% include svg-icons.html %}
45+
</footer>
46+
</div>
47+
</div>
48+
49+
{% include analytics.html %}
50+
</body>
51+
</html>

‎_layouts/page.html

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: default
3+
---
4+
5+
<article class="page">
6+
7+
<h1>{{ page.title }}</h1>
8+
9+
<div class="entry">
10+
{{ content }}
11+
</div>
12+
</article>

‎_layouts/post.html

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: default
3+
---
4+
5+
<article class="post">
6+
<h1>{{ page.title }}</h1>
7+
8+
<div class="entry">
9+
{{ content }}
10+
</div>
11+
12+
<div class="date">
13+
Written on {{ page.date | date: "%B %e, %Y" }}
14+
</div>
15+
16+
{% include disqus.html %}
17+
</article>

0 commit comments

Comments
 (0)