jekyll-apple 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c56c51de21b72ca25370e443fef8b8fe70c7018
+  data.tar.gz: 3bcc3204bfb1c2ffaef73f99783085e1225f34e4
+SHA512:
+  metadata.gz: 27505cd4f66676a0d149d8f7776b2ffe83e4a9877289750845e1539b15733b8066a002f17f9e508e2746e4fef78e1bb697c86a2a9590b7ff8f8c334ab8b3e8b1
+  data.tar.gz: 71b8166e09d93cac53de7481c3155a85b08c28b8c8b88eeedeed991254836329cbf8f71ec05543aa174aacf4a1a53c3c157b4eb20596174034afc3328f7f0cb1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# ChangeLog
+
+## HEAD
+
+- n/a
+
+## 1.0.0
+
+- Initial release

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,311 @@
+# jekyll-apple
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-apple.svg)](https://badge.fury.io/rb/jekyll-apple)
+[![Build Status](https://travis-ci.org/nullpixel/jekyll-apple.svg?branch=master)](https://travis-ci.org/nullpixel/jekyll-apple)
+
+Minimal, apple style jekyll theme.
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+``` ruby
+gem "jekyll-apple"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+``` yaml
+theme: jekyll-apple
+```
+
+And then execute:
+
+``` sh
+bundle
+```
+
+Or install it yourself as:
+
+``` sh
+gem install jekyll-apple
+```
+
+## Quick Start
+
+1. Generate a new Jekyll blog:
+
+   ``` sh
+   jekyll new blog --skip-bundle
+   cd blog
+   ```
+
+2. Edit `Gemfile` to use apple theme:
+
+   ``` ruby
+   gem "jekyll-apple"
+   ```
+
+3. Edit `_config.yml` to use apple theme and its plugins:
+
+   ``` yaml
+   theme: jekyll-apple
+   gems:
+     - jekyll-archives
+     - jekyll-paginate
+     - jekyll-sitemap
+
+   permalink: /:year/:month/:day/:title/
+   paginate_path: /posts/:num/
+   paginate: 5
+
+   jekyll-archives:
+     enabled:
+       - categories
+     layout: category_archives
+     permalinks:
+       category: /categories/:name/
+   ```
+
+4. Copy
+   [`index.html`](https://github.com/nullpixel/jekyll-appleblob/master/index.html),
+   [`about.md`](https://github.com/nullpixel/jekyll-appleblob/master/about.md),
+   [`archives.md`](https://github.com/nullpixel/jekyll-appleblob/master/archives.md),
+   [`feed.xml`](https://github.com/nullpixel/jekyll-appleblob/master/feed.xml), and
+   [`_data/navigation.yml`](https://github.com/nullpixel/jekyll-appleblob/master/_data/navigation.yml)
+   from the theme:
+
+   ``` sh
+   rm index.md
+   curl -L -O "https://github.com/nullpixel/jekyll-apple/raw/master/{index.html,about.md,archives.md,feed.xml}"
+   curl -L --create-dirs -o _data/navigation.yml https://github.com/nullpixel/jekyll-apple/raw/master/_data/navigation.yml
+   ```
+
+5. Install gems and you're good to go! The blog will be available on
+   `http://127.0.0.1:4000`.
+
+   ``` sh
+   bundle install
+   bundle exec jekyll serve
+   ```
+
+## Usage
+
+### Customization
+
+To override the default structure and style of jekyll-apple, simply create the
+concerned directory at the root of your site, copy the file you wish to
+customize to that directory, and then edit the file. e.g., to override the
+[`_includes/footer_content.html`](_includes/footer_content.html) file to add
+contents to footer, create an `_includes` directory, copy
+`_includes/footer_content.html` from jekyll-apple gem folder to
+`<your-site>/_includes` and start editing that file.
+
+For example, you can add favicons to `_includes/head_custom.html`:
+
+``` html
+<link rel="icon" type="image/x-icon" href="{{ "/favicon.ico" | relative_url }}">
+<link rel="apple-touch-icon" href="{{ "/apple-touch-icon.png" | relative_url }}">
+<link rel="apple-touch-icon" sizes="76x76" href="{{ "/apple-touch-icon-76x76.png" | relative_url }}">
+<link rel="apple-touch-icon" sizes="120x120" href="{{ "/apple-touch-icon-120x120.png" | relative_url }}">
+<link rel="apple-touch-icon" sizes="152x152" href="{{ "/apple-touch-icon-152x152.png" | relative_url }}">
+<link rel="apple-touch-icon" sizes="180x180" href="{{ "/apple-touch-icon-180x180.png" | relative_url }}">
+```
+
+The site's default CSS is in the gem itself,
+[`assets/main.scss`](assets/main.scss). To override the default CSS, the file
+has to exist at your site source. Do either of the following:
+
+- Create a new instance of `main.scss` at site source
+  - Create a new file `main.scss` at `<your-site>/assets/`
+  - Add the frontmatter dashes, and
+  - Add `@import "apple";`, to `<your-site>/assets/main.scss`
+  - Add your custom CSS
+- Download the file from this repo
+  - Create a new file `main.scss` at `<your-site>/assets/`
+  - Copy the contents at [`assets/main.scss`](assets/main.scss) onto the `main.scss` you just created, and edit away
+- Copy directly from jekyll-apple gem
+  - Go to your local jekyll-apple gem installation directory (run `bundle show jekyll-apple` to get the path to it)
+  - Copy the `assets/` folder from there into the root of `<your-site>`
+  - Change whatever values you want, inside `<your-site>/assets/main.scss`
+
+### Locale
+
+`site.lang` is used to declare the primary language for each web page within the
+site.
+
+`lang: en-US` sets the `lang` attribute for the site to the United States flavor
+of English, while `en-GB` would be for the United Kingdom style of English.
+Country codes are optional and the shorter variation `lang: en` is also
+acceptable. You may want to write a post in different language, then add `lang`
+attribute to the frontmatter of that post:
+
+``` yaml
+layout: post
+title: "안녕하세요"
+lang: ko
+```
+
+### Description
+
+`site.description` describes the site. This is mainly used in meta descriptions
+for improving SEO. Also, you can set `description` attribute for each post:
+
+``` yaml
+layout: post
+title: Awesome Post
+description: This is an awesome post.
+```
+
+If you don't specify `post.description`, then `post.excerpt` will be used if it
+exist.
+
+### External URL
+
+`external-url` turns the title of your post to a link. Specify a URL which you
+want to link to.
+
+``` yaml
+layout: post
+title: Jekyll apple theme
+external-url: https://github.com/nullpixel/jekyll-apple
+```
+
+Then the title of your post would look like a link with text
+`Jekyll apple theme →`. This also applies to your blog feed.
+
+### Category
+
+Each post can have `categories` attribute. It can be a string or an array. This
+will be displayed on index, archive and each post, and provide a link to the
+archive of category.
+
+``` yaml
+layout: post
+title: Awesome Post
+categories: Misc
+```
+
+``` yaml
+layout: post
+title: Another Awesome Post
+categories:
+  - Misc
+  - Idea
+```
+
+### Feed
+
+Create `<your-site>/feed.xml` with:
+
+``` yaml
+---
+layout: feed
+---
+```
+
+If you want to use another path for feed, you can specify a non-default path via
+your site's config.
+
+``` yaml
+feed:
+  path: atom.xml
+```
+
+Then create `<your-site>/atom.xml` with the same content of `feed.xml` above.
+
+### Comments
+
+jekyll-apple provides the ability to include your favourite commenting service, like [Disqus](https://disqus.com) or [Isso](https://posativ.org/isso).
+
+To enable comments on pages and posts:
+1. Overwrite the `_includes/custom_comments_provider.html` with your custom provider of comments.
+2. Add `comments: true` to your `_config.yml`.
+
+To disable comments on certain pages or posts specify `comments: false` in the front matter of the page or post.
+
+### Metadata for SEO
+
+#### Keywords
+
+Each post can have `keywords` attribute. This is a comma-separated list which is
+used in meta descriptions for improving SEO.
+
+``` yaml
+layout: post
+title: How to configure jekyll-apple
+keywords: jekyll, apple, github pages
+```
+
+YAML list is also available:
+
+``` yaml
+keywords:
+  - jekyll
+  - apple
+  - github pages
+```
+
+#### Twitter
+
+- `site.twitter_username` sets `twitter:site` and `twitter:creator` meta tag
+- `site.twitter_image` sets `twitter:image:src` meta tag
+- `page.twitter_card.type` sets `twitter:card` meta tag (default: `summary`)
+  - If `page.twitter_card.type` is `gallery`, it sets `twitter:image0`, `twitter:image1`, `twitter:image2` and `twitter:image3` meta tags with `page.twitter_card.image`, `page.twitter_card.image1`, `page.twitter_card.image2` and `page.twitter_card.image3`, respectively
+  - If `page.twitter_card.type` is `photo`, `page.twitter_card.width` sets `twitter:image:width` meta tag and `page.twitter_card.height` sets `twitter:image:height` meta tag
+- `page.twitter_card.creator` sets `twitter:creator` meta tag. It overrides `site.twitter_username`
+- `page.twitter_card.image` sets `twitter:image:src` meta tag if `page.twitter_card.type` is not `gallery`. It overrides `site.twitter_image`
+
+#### Facebook
+
+- `site.facebook_app_id` sets `fb:admins` meta tag
+- `site.facebook_page` sets `article:author` meta tag
+- `site.facebook_image` sets `og:image` meta tag
+- `page.facebook.image` sets `og:image` meta tag. It overrides `site.facebook_image`
+
+### Navigation
+
+To define header links, add titles and URLs under the `main` key in
+`_data/navigation.yml`:
+
+``` yaml
+main:
+  - title: "About"
+    url: /about/
+  - title: "Archives"
+    url: /archives/
+  - title: "GitHub"
+    url: https://github.com/yous/whiteglass
+```
+
+### Enabling Google Analytics
+
+To enable Google Analytics, add the following lines to your Jekyll site:
+
+``` yaml
+google_analytics: UA-NNNNNNNN-N
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/nullpixel/jekyll-apple>. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run
+`bundle exec jekyll serve` and open your browser at
+`http://localhost:4000/apple/`. This starts a Jekyll server using your
+theme. Add pages, documents, data, etc. like normal to test your theme's
+contents. As you make modifications to your theme and to your content, your site
+will regenerate and you should see the changes in the browser after a refresh,
+just like normal.
+
+## License
+
+The theme is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/_includes/custom_comments_provider.html

@@ -0,0 +1,3 @@
+<hr />
+<h1>Comments</h1>
+<p>Insert your custom comment provider like <a href="https://disqus.com">Disqus</a> or <a href="https://posativ.org/isso">Isso</a> here.</p>

data/_includes/fonts.html

@@ -0,0 +1,14 @@
+<script type="text/javascript">
+  WebFontConfig = {
+    google: { families: [ 'Bitter:400,700,400italic:latin' ] }
+  };
+  (function() {
+    var wf = document.createElement('script');
+    wf.src = ('https:' == document.location.protocol ? 'https' : 'http') +
+      '://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js';
+    wf.type = 'text/javascript';
+    wf.async = 'true';
+    var s = document.getElementsByTagName('script')[0];
+    s.parentNode.insertBefore(wf, s);
+  })();
+</script>

data/_includes/footer.html

@@ -0,0 +1,11 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+    <p>
+      {% include footer_content.html %}
+    </p>
+
+  </div>
+
+</footer>

data/_includes/footer_content.html

@@ -0,0 +1,5 @@
+{% assign feed_path = "/feed.xml" %}
+{% if site.feed and site.feed.path %}
+  {% assign feed_path = site.feed.path %}
+{% endif %}
+&copy; {{ site.author }} - Powered by <a href="https://jekyllrb.com">Jekyll</a> &amp; <a href="https://github.com/nullpixel/jekyll-apple">jekyll-apple</a> - Subscribe via <a href="{{ feed_path | absolute_url }}">RSS</a>

data/_includes/google_analytics.html

@@ -0,0 +1,13 @@
+{% if site.google_analytics %}
+  <!-- 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 }}', 'auto');
+    ga('send', 'pageview');
+
+  </script>
+{% endif %}

data/_includes/head.html

@@ -0,0 +1,71 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  {% assign title = page.title | default: site.title | escape %}
+  {% assign canonical = page.url | replace:'index.html','' | absolute_url %}
+  {% assign description = page.description | default: page.excerpt | default: site.description | strip_html | normalize_whitespace | escape %}
+  <title>{{ title }}</title>
+  <meta name="description" content="{{ description }}">
+  {% if page.keywords %}
+    {% if page.keywords.first %}
+      {% assign keywords = page.keywords | join: ',' %}
+    {% else %}
+      {% assign keywords = page.keywords %}
+    {% endif %}
+    <meta name="keywords" content="{{ keywords }}">
+  {% endif %}
+
+  <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
+  <link rel="canonical" href="{{ canonical }}">
+  {% assign feed_path = "/feed.xml" %}
+  {% if site.feed and site.feed.path %}
+    {% assign feed_path = site.feed.path %}
+  {% endif %}
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ feed_path | absolute_url }}">
+
+  {% include head_custom.html %}
+
+  {% if site.facebook_app_id %}
+    <meta property="fb:admins" content="{{ site.facebook_app_id }}">
+    <meta property="og:title" content="{{ title }}">
+    <meta property="og:site_name" content="{{ site.title | escape }}">
+    <meta property="og:url" content="{{ canonical }}">
+    <meta property="og:description" content="{{ description }}">
+    {% if site.facebook_page %}<meta property="article:author" content="{{ site.facebook_page }}">{% endif %}
+    {% if page.facebook.image %}
+      <meta property="og:image" content="{{ page.facebook.image }}">
+    {% elsif site.facebook_image %}
+      <meta property="og:image" content="{{ site.facebook_image }}">
+    {% endif %}
+  {% endif %}
+  <meta name="twitter:card" content="{{ page.twitter_card.type | default: "summary" }}">
+  {% if site.twitter_username %}<meta name="twitter:site" content="{{ site.twitter_username }}">{% endif %}
+  <meta name="twitter:title" content="{{ title | truncate: 70 }}">
+  <meta name="twitter:description" content="{{ description | truncate: 200 }}">
+  {% if page.twitter_card.creator %}
+    <meta name="twitter:creator" content="{{ page.twitter_card.creator }}">
+  {% elsif site.twitter_username %}
+    <meta name="twitter:creator" content="{{ site.twitter_username }}">
+  {% endif %}
+  {% if page.twitter_card.image %}
+    {% if page.twitter_card.type == 'gallery' %}
+      <meta name="twitter:image0" content="{{ page.twitter_card.image }}">
+      <meta name="twitter:image1" content="{{ page.twitter_card.image1 }}">
+      <meta name="twitter:image2" content="{{ page.twitter_card.image2 }}">
+      <meta name="twitter:image3" content="{{ page.twitter_card.image3 }}">
+    {% else %}
+      <meta name="twitter:image:src" content="{{ page.twitter_card.image }}">
+      {% if page.twitter_card.type == 'photo' %}
+        {% if page.twitter_card.width %}<meta name="twitter:image:width" content="{{ page.twitter_card.width }}">{% endif %}
+        {% if page.twitter_card.height %}<meta name="twitter:image:height" content="{{ page.twitter_card.height }}">{% endif %}
+      {% endif %}
+    {% endif %}
+  {% elsif site.twitter_image %}
+    <meta name="twitter:image:src" content="{{ site.twitter_image }}">
+  {% endif %}
+
+  {% include fonts.html %}
+  {% include google_analytics.html %}
+</head>