arco 0.3.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7d5d883eae71c2eb4e4455e8051eb5c1a9b31c8f282cc1a6d1b2d2eef9c0fb
-  data.tar.gz: 2f96e9d9382608f680dbbefd7e18210c3a308e9bceff204529c5a53a8fe8888d
+  metadata.gz: 6cf35d196050f4bd10853f6114f8c6721116967ffb6ee675a2af18f82759374f
+  data.tar.gz: 6c1dad515a172985ae475af3df05260633c784ca213e22cc965eefc583f4a756
 SHA512:
-  metadata.gz: 2d536694036284f8fcc2029e07a58d4dd6e66a5182bad04803f51e367f59223cc062c408fafed8c49401e8a49907e240e5f8eebffb9802d3c51201257b99fa1a
-  data.tar.gz: 2461f98176db3b6f1d90de5475792ea48015be67e5b5872078e0cc7f86cf68402fe3b0d6fe1c0c5c794d7ea4f374795f21ee3bb3dbbe06a5dce67a6b48821871
+  metadata.gz: e82d454f28a27de909cde6319a6af6b101d0c36917685a0ffe5ffc8da0244cdddaf18448fd8a998c26d437e5708f106dfc3755d3fa84023683a78a0b8cdcee9e
+  data.tar.gz: dfb34396c18c33ffb6f5ab54441e88b6ba8adb13c2da1e0fe20522f61f0ee1e085b87f7531cd3fed1c055cf0e7cab445e888c39157a2ba557838637c7c87c030

data/README.md

@@ -1,6 +1,10 @@
 # arco
 
-Arco is a responsive fixed-sidebar layout with a two column masonry grid which also features a landing page, a 404 page and a simple permalink structure.
+Arco is a responsive fixed-sidebar layout with a two column masonry grid which also features a landing page, a 404 page, smooth page transitions and a simple permalink structure.
+
+This theme also utilises [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) and [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) to ensure your work will be seen.
+
+See this theme in use at [meebuhs.github.io](https://meebuhs.github.io) and check the [source code](https://github.com/meebuhs/meebuhs.github.io) to get yourself started.
 
 ## Installation
 
@@ -24,35 +28,68 @@ Or install it yourself as:
 
     $ gem install arco
 
+## Github Pages
+
+In your `_config.yml` delete the `theme: ` line and add:
+
+```yaml
+remote_theme: meebuhs/arco
+```
+
+You also need to make the following changes in your `Gemfile`:
+
+```Gemfile
+# Comment the jekyll gem
+# gem "jekyll", "~> 4.1.0"
+# Uncomment github-pages
+gem "github-pages", group: :jekyll_plugins
+```
+
 ## Usage
 
+### Setup
+
+To get started you need to copy the `pages` folder from this repository to your site.
+
+By default it features a landing page, if you would like to bypass the landing page, delete `index.html` and then rename `projects.html` to `index.html`.
+
 ### Site configuration
 
 The following settings can be configured in your site's `_config.yml`
 
 ```yaml
-title: Site title
-description: Site description
-image: /assets/image.png
+title: site-title
+tagline: site-tagline
+description: site-description
+image: /assets/images/image.png
+url: https://github.com/meebuhs/arco
 github_url: https://github.com/meebuhs
 resume: true | false
+author: Alex Sharpe
+lang: en-AU
 ```
 
+There are additional parameters which can be set for use with `jekyll-seo-tag`. [See here for a complete list](https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md)
+
 ### Expected post frontmatter
 
 ```
 ---
 layout: post
 title: Post title
-summary: Post summary
+description: Post description
 category: completed | ongoing
 permalink: /projects/post-title
 cover-image: /assets/image-for-front-page.png
-top-image: /assets/image-for-top-of-post.png 
+image: /assets/image-for-top-of-post.png 
 mathjax: true | false
 ---
 ```
 
+### Markdown features
+
+[Check here](https://meebuhs.github.io/projects/arco) for examples of the supported markdown features.
+
 ### Resume support
 
 To add a resume to the site, set `resume: true` in your `_config.yml`.

data/_config.yml

@@ -1,7 +1,16 @@
-title: sitetitle
-description: sitedescription
+# Site settings
+title: site-title
+tagline: site-tagline
+description: site-description
 image: /assets/images/image.png
+url: https://github.com/meebuhs/arco
 github_url: https://github.com/meebuhs
 resume: true
+author: Alex Sharpe
+lang: en-AU
+
+# Build settings
 theme: arco
-highlighter: rouge
+plugins:
+  - jekyll-seo-tag
+  - jekyll-sitemap

data/_includes/cover.html

@@ -1,4 +1,4 @@
-<section id="cover" class="cover"> 
+<section class="cover"> 
     <div class="cover-text">
       {% if site.image %}<img class="site-image" src="{{ site.image }}" />{% endif %}
       <h1>{{ site.title }}</a></h1>

data/_layouts/default.html

@@ -5,6 +5,7 @@
     <link rel="stylesheet" href="/assets/css/main.css">
     <link rel="stylesheet" href="/assets/flexmasonry/flexmasonry.css">
     <script src="/assets/flexmasonry/flexmasonry.js"></script>
+    {% seo %}
   </head>
   <body>
     {% include sidebar.html %}

data/_layouts/landing.html

@@ -3,6 +3,7 @@
   <head>
     <meta charset="UTF-8">
     <link rel="stylesheet" href="/assets/css/main.css">
+    {% seo %}
   </head>
   <body>
     {% include cover.html %}

data/_layouts/post.html

@@ -2,18 +2,21 @@
 layout: default
 ---
 
-{% include mathjax.html %}
+{% if page.mathjax %}
+  {% include mathjax.html %}
+{% endif %}
 
 <section class="content">
   <svg id="content-fader"></svg>
   <div class="post">
     <div class="post-title"><h1>{{ page.title }}</h1></div>
+    <div class="post-description">{{ page.description }}</div>
     <div class="post-header">
       <span class="post-date">{{ page.date | date_to_string}}</span>
       &middot;
       <a href="{{ "/projects/" }}{{ page.category }}" class="fade-onclick"><span class="post-category">{{ page.category }}</span></a>
     </div>
-    <img class="post-image" src="{{ page.top-image }}" />
+    <img class="post-image" src="{{ page.image }}" />
 
     <div class="post-content">
       {{ content }}

data/_sass/cover.scss

@@ -19,13 +19,6 @@
     }
 }
 
-#open-button {
-    display: flex;
-    flex-direction: column;
-    justify-content: center;
-    text-align: center;
-}
-
 .open-button-container {
     width: 100%;
     margin-top: 20px;
@@ -43,28 +36,7 @@
     background: $sidebar-colour;
     color: $text-colour-light;
     transition: all .25s ease;
+    flex-direction: column;
+    text-align: center;
+    justify-content: center;
 }
-
-/* vertical layout */
-@media only screen and (max-width: calc(2 * #{$sidebar-width - 1})), (orientation: portrait) {
-    #cover {
-        flex-direction: row;
-        justify-content: space-evenly;
-        align-items: center;
-        text-align: center;
-    }
-
-    .cover-text {
-        display: flex;
-        flex-direction: column;
-    }
-}
-
-/* horizontal layout */
-@media only screen and (min-width: calc(2 * #{$sidebar-width})) and (orientation: landscape) {
-    #cover {
-        flex-direction: column;
-        text-align: center;
-        justify-content: center;
-    }
-}

data/_sass/post.scss

@@ -3,10 +3,14 @@
     width: 100%;
 }
 
-.post-title h1{
+.post-title h1 {
     margin-bottom: 0;
 }
 
+.post-description {
+    margin-bottom: 0.5em;
+}
+
 .post-date {
     color: $secondary-highlight;
     font-weight: bold;
@@ -34,4 +38,5 @@
     max-height: 600px;
     display: block;
     margin: 0 auto;
+    border-radius: 5px;
 }

data/_sass/sidebar.scss

@@ -32,8 +32,8 @@
     transition: all .35s ease;
 }
 
-/* vertical layout */
-@media only screen and (max-width: calc(2 * #{$sidebar-width - 1})), (orientation: portrait) {
+/* portrait layout */
+@media only screen and (max-width: 768px), (orientation: portrait) {
     #sidebar {
         flex-direction: row;
         justify-content: space-evenly;
@@ -94,8 +94,8 @@
     }
 }
 
-/* horizontal layout */
-@media only screen and (min-width: calc(2 * #{$sidebar-width})) and (orientation: landscape) {
+/* landscape layout */
+@media only screen and (min-width: 768px), (orientation: landscape) {
     #sidebar {
         flex-direction: column;
         text-align: center;

data/_sass/syntax-highlighting.scss

@@ -42,6 +42,7 @@ pre code {
   border-radius: 5px;
   pre {
     position: relative;
+    border-radius: 5px;
   }
   pre code {
     color: #cccccc;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arco
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.3
 platform: ruby
 authors:
 - meebuhs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll