arco 0.2.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f309ed261570f257e221b24de154d9c7d9b0f2f443a73a25a88775ab4b83ef27
-  data.tar.gz: 871b1fcc3c148d04d37ccd2daee45430ec53c169cdf8cd4fcfbfe03e67d5a876
+  metadata.gz: 7beb38bf0a9a4adf4aaef25d3efe27ad09db049c4a758f6d1398903b1ca7be66
+  data.tar.gz: 44d36acf3c59cb7bd38f2d2e42bc5eff4a5373299cc1cd2878b2740ace5bdd96
 SHA512:
-  metadata.gz: 1174e51ab1b86d2c54ce1ca29cf2d2032a5249bcbb5f0bd133f894b1e4eca76b7d21c3df181a170e94773b4552c94ca202c7b8f839991df6c35db6e21803ccd4
-  data.tar.gz: 6a058386d888ec2ee6bc5f30deda5f863b662e66ab6165348fe03544d9e401c76b9153c41a801288196a432c3fad043b647efa54bd45ba1ee5e21c112516796e
+  metadata.gz: 45504652d58ebb721e9e0987db680eb0453410ae02c169bdb5c5d06aa5232dc829a2c2f59f627a46c3fe72e6cae8a66c7ec1afc60fc72b5d16c9a66e8b4cf8ea
+  data.tar.gz: 22ff65c7b2342089b236e1ff4de8c2f87693fb5a00790e1c86e381022a63027bdc679a1fe94e043c4c1ed0c666dcd171267fd93748ef42466fb917f4a5e96880

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 [https://github.com/meebuhs/meebuhs.github.io](source code) 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,10 +1,10 @@
-<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>
       <h6>{{ site.description }}</h6>
     </div>
-    <div id="open-button-container" class="open-button-container">
-        <a href="/projects/" class="open-button">See my projects</a>
+    <div class="open-button-container">
+        <a href="/projects/" id="open-button" class="button-dark">See my projects</a>
     </div>
 </section>

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/arco.scss

@@ -84,12 +84,9 @@ blockquote {
     padding: 0.5em 1em;
 }
 
-table, th, td {
-  border: none;
-}
-
 .table {
   display: table;
+  border-collapse: collapse;
 }
 
 .table-cell {
@@ -114,14 +111,6 @@ table {
     > tr:nth-child(odd) {
       background-color: $table-background-colour;
     }
-    > tr > td {
-      border-radius: 0;
-    }
-  }
-  &.centered {
-    thead tr th, tbody tr td, tfoot tr td {
-      text-align: center;
-    }
   }
 }
 
@@ -130,7 +119,6 @@ td, th {
   display: table-cell;
   text-align: left;
   vertical-align: middle;
-  border-radius: 2px;
 }
 
 li, ul {

data/_sass/buttons.scss

@@ -0,0 +1,47 @@
+@mixin button($background, $highlight) {
+    display: inline-block;
+    padding: 10px 25px;
+    border-radius: 5px;
+    transition: all .25s ease;
+    justify-content: center;
+    text-align: center;
+    border: 2px solid $background;
+    background-color: $background;
+    color: $highlight;
+    &:hover, &:focus {
+        background-color: $highlight;
+        color: $background;
+    }
+}
+
+.button-dark {
+    @include button(white, $sidebar-colour)
+}
+
+.button-dark-primary {
+    @include button($primary-highlight, $sidebar-colour)
+}
+
+.button-dark-secondary {
+    @include button($secondary-highlight, $sidebar-colour)
+}
+
+.button-dark-tertiary {
+    @include button($tertiary-highlight, $sidebar-colour)
+}
+
+.button-light {
+    @include button($sidebar-colour, white)
+}
+
+.button-light-primary {
+    @include button($primary-highlight, white)
+}
+
+.button-light-secondary {
+    @include button($secondary-highlight, white)
+}
+
+.button-light-tertiary {
+    @include button($tertiary-highlight, white)
+}

data/_sass/cover.scss

@@ -19,22 +19,11 @@
     }
 }
 
-.open-button {
-    height: 50px;
-    width: 200px;
-    border: 2px solid white;
-    border-radius: 5px;
-    transition: all .25s ease;
+#open-button {
     display: flex;
     flex-direction: column;
     justify-content: center;
     text-align: center;
-    background-color: $sidebar-colour;
-    color: white;
-    &:hover, &:focus {
-        background-color: white;
-        color: $sidebar-colour
-    }
 }
 
 .open-button-container {
@@ -54,28 +43,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/syntax-highlighting.scss

@@ -39,8 +39,10 @@ pre code {
 
 .highlight {
   margin: 0;
+  border-radius: 5px;
   pre {
     position: relative;
+    border-radius: 5px;
   }
   pre code {
     color: #cccccc;

data/assets/css/main.scss

@@ -9,4 +9,5 @@
 @import "post-list";
 @import "post";
 @import "normalize";
-@import "syntax-highlighting";
+@import "syntax-highlighting";
+@import "buttons";

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: arco
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - meebuhs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '3.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 description: 
 email:
 - meebuhs@gmail.com
@@ -46,6 +52,7 @@ files:
 - _layouts/resume.html
 - _sass/404.scss
 - _sass/arco.scss
+- _sass/buttons.scss
 - _sass/constants.scss
 - _sass/cover.scss
 - _sass/fonts.scss