creek-jekyll-theme 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5bef234714787722e8a5f047d0bcc31535f5dafa9fdcd8177dbfed46f6d92a
-  data.tar.gz: 72938cdf0ac10d105051f3bf3677890f4f393d147fe5e7e7a79146067dc71afb
+  metadata.gz: 27f1e86fc1380f54b360d69c7fa202e659aa36b378df1f9cc009a3a7ab004035
+  data.tar.gz: 0bd98679a4a049f2cb4b1739d9d643ee211079434516f2073e00352489f4a4bf
 SHA512:
-  metadata.gz: c8a297b88a5749798615224015cab0f2c4b532e45c6f941521b0702a39814f7af6d5e19cbebabd23a270e74014e65a238d1bac557ac533c8a3771c60bdb6370a
-  data.tar.gz: 9406c298bc2fb542d49364b88929f4e738d65a4a916f11d2353e8043e346399b5aafc130dae86c6b12ade8da27181fb2a37b41a163e99dff6d0e318101726ed5
+  metadata.gz: 506a736b0652cf1e9229a6ad14acfc44f9064a28b4e8e5d8df1e2378b3e6b94d60ad41ec0fc829b3ce0550b23df1ec3bc6f23720526e133c293c9f9c7a90e90e
+  data.tar.gz: d8c533f02d17f9194ffd2b18f9533f4989ed906e45baa316444b990e7420585e2d0bc6406edb7d1cf5d0da1ba39f4c388a6fe34594c6cf15010001655cf269a0

data/_config.yml

@@ -0,0 +1,334 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your entire site, values
+# which you are expected to set up once and rarely need to edit after that.
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# `jekyll serve`. If you change this file, please restart the server process.
+
+# Note: the _config.yml and _data/ files in the theme are not picked up by repos using the theme.
+# Requires: https://github.com/github/pages-gem/pull/855
+
+# remote_theme           : "creek-service/creek-service.github.io"
+minimal_mistakes_skin    : "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
+
+# Site Settings
+locale                   : "en-US"
+title                    : "Creek Service"
+title_separator          : "-"
+name                     : "Creek Service"
+description              : "Quickly build & test an ecosystem of JVM based microservices, using Kafka clients, Kafka Streams and more." # Used in SEO
+url                      : "https://www.creekservice.org"
+# baseurl                  : # the subpath of your site, e.g. "/blog"
+repository               : # GitHub username/repo-name e.g. "mmistakes/minimal-mistakes"
+teaser                   : # path of fallback teaser image, e.g. "/assets/images/500x300.png"
+logo                     : "/assets/images/creek-logo.png" # path of logo image to display in the masthead, e.g. "/assets/images/88x88.png"
+masthead_title           : "Write business logic" # overrides the website title displayed in the masthead, use " " for no title
+subtitle                 : "Not boilerplate" # custom site tagline that appears below site title in masthead
+breadcrumbs            : false # true, false (default)
+words_per_minute         : 200
+comments:
+  provider               : # false (default), "disqus", "discourse", "facebook", "staticman", "staticman_v2", "utterances", "giscus", "custom"
+  disqus:
+    shortname            : # https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-
+  discourse:
+    server               : # https://meta.discourse.org/t/embedding-discourse-comments-via-javascript/31963 , e.g.: meta.discourse.org
+  facebook:
+    # https://developers.facebook.com/docs/plugins/comments
+    appid                :
+    num_posts            : # 5 (default)
+    colorscheme          : # "light" (default), "dark"
+  utterances:
+    theme                : # "github-light" (default), "github-dark"
+    issue_term           : # "pathname" (default)
+  giscus:
+    repo_id              : # Shown during giscus setup at https://giscus.app
+    category_name        : # Full text name of the category
+    category_id          : # Shown during giscus setup at https://giscus.app
+    discussion_term      : # "pathname" (default), "url", "title", "og:title"
+    reactions_enabled    : # '1' for enabled (default), '0' for disabled
+    theme                : # "light" (default), "dark", "dark_dimmed", "transparent_dark", "preferred_color_scheme"
+  staticman:
+    branch               : # "master"
+    endpoint             : # "https://{your Staticman v3 API}/v3/entry/github/"
+reCaptcha:
+  siteKey                :
+  secret                 :
+atom_feed:
+  path                   : # blank (default) uses feed.xml
+  hide                   : # true, false (default)
+search                   : # true, false (default)
+search_full_content      : # true, false (default)
+search_provider          : # lunr (default), algolia, google
+lunr:
+  search_within_pages    : # true, false (default)
+algolia:
+  application_id         : # YOUR_APPLICATION_ID
+  index_name             : # YOUR_INDEX_NAME
+  search_only_api_key    : # YOUR_SEARCH_ONLY_API_KEY
+  powered_by             : # true (default), false
+google:
+  search_engine_id       : # YOUR_SEARCH_ENGINE_ID
+  instant_search         : # false (default), true
+# SEO Related
+google_site_verification :
+bing_site_verification   :
+naver_site_verification  :
+yandex_site_verification :
+baidu_site_verification  :
+
+# Social Sharing
+twitter:
+  username               :
+facebook:
+  username               :
+  app_id                 :
+  publisher              :
+og_image                 : "/assets/images/creek-logo.png" # Open Graph/Twitter default site image
+# For specifying social profiles
+# - https://developers.google.com/structured-data/customize/social-profiles
+social:
+  type                   : # Person or Organization (defaults to Person)
+  name                   : # If the user or organization name differs from the site's name
+  links: # An array of links to social media profiles
+
+# Analytics
+analytics:
+  provider               : "google" # false (default), "google", "google-universal", "google-gtag", "custom"
+  google:
+    tracking_id          : "G-CZC5Z8YNH8"
+    anonymize_ip         : true # true, false (default)
+
+
+# Site Author
+author:
+  name             : "Andy Coates"
+  avatar           : # path of avatar image, e.g. "/assets/images/bio-photo.jpg"
+  bio              : "Software engineer with a passion for building working, scalable, systems"
+  location         : "UK"
+  email            :
+  links:
+    - label: "Creek Service"
+      icon: "fas fa-fw fa-link"
+      url: "https://www.creekservice.org"
+    - label: "GitHub"
+      icon: "fab fa-fw fa-github"
+      url: "https://github.com/big-andy-coates"
+    - label: "linkedin"
+      icon: "fab fa-fw fa-linkedin"
+      url: "https://www.linkedin.com/in/andrew-coates-33874a44"
+
+# Site Footer
+footer:
+  links:
+    - label: "Twitter"
+      icon: "fab fa-fw fa-twitter-square"
+      # url:
+    - label: "Facebook"
+      icon: "fab fa-fw fa-facebook-square"
+      # url:
+    - label: "GitHub"
+      icon: "fab fa-fw fa-github"
+      url: "https://github.com/creek-service"
+    - label: "GitLab"
+      icon: "fab fa-fw fa-gitlab"
+      # url:
+    - label: "Bitbucket"
+      icon: "fab fa-fw fa-bitbucket"
+      # url:
+    - label: "Instagram"
+      icon: "fab fa-fw fa-instagram"
+      # url:
+
+
+# Reading Files
+include:
+  - .htaccess
+  - _pages
+exclude:
+  - "*.sublime-project"
+  - "*.sublime-workspace"
+  - vendor
+  - .asset-cache
+  - .bundle
+  - .jekyll-assets-cache
+  - .sass-cache
+  - assets/js/plugins
+  - assets/js/_main.js
+  - assets/js/vendor
+  - Capfile
+  - CHANGELOG
+  - config
+  - Gemfile
+  - Gruntfile.js
+  - gulpfile.js
+  - LICENSE
+  - log
+  - node_modules
+  - package.json
+  - package-lock.json
+  - Rakefile
+  - README
+  - tmp
+  - /docs
+keep_files:
+  - .git
+  - .svn
+encoding: "UTF-8"
+markdown_ext: "markdown,mkdown,mkdn,mkd,md"
+
+
+# Conversion
+markdown: kramdown
+highlighter: rouge
+lsi: false
+excerpt_separator: "\n\n"
+incremental: false
+
+
+# Markdown Processing
+kramdown:
+  input: GFM
+  hard_wrap: false
+  auto_ids: true
+  footnote_nr: 1
+  entity_output: as_char
+  toc_levels: 1..6
+  smart_quotes: lsquo,rsquo,ldquo,rdquo
+  enable_coderay: false
+
+
+# Collections
+collections:
+  demos:
+    output: true
+    permalink: /:collection/:path/
+
+# Defaults
+defaults:
+  # _posts
+  - scope:
+      path: ""
+      type: posts
+    values:
+      layout: single
+      author_profile: true
+      read_time: true
+      comments: false # true
+      share: true
+      related: false # true
+  # _pages
+  - scope:
+      path: "_pages"
+      type: pages
+    values:
+      layout: single
+      author_profile: false
+      toc: true
+      toc_sticky: true
+  # _demos
+  - scope:
+      path: ""
+      type: demos
+    values:
+      layout: single
+      read_time: false
+      author_profile: false
+      share: false
+      comments: false
+      sidebar:
+        nav: "docs"
+      toc: true
+      toc_sticky: true
+  # _recipes
+  - scope:
+      path: ""
+      type: recipes
+    values:
+      layout: single
+      author_profile: true
+      share: true
+      comments: true
+  # _pets
+  - scope:
+      path: ""
+      type: pets
+    values:
+      layout: single
+      author_profile: true
+      share: true
+      comment: true
+  # _portfolio
+  - scope:
+      path: ""
+      type: portfolio
+    values:
+      layout: single
+      author_profile: false
+      share: true
+
+# Sass/SCSS
+sass:
+  sass_dir: _sass
+  style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
+
+
+# Outputting
+permalink: /:categories/:title/
+paginate: 5 # amount of posts to show
+paginate_path: /page:num/
+timezone: "Europe/London" # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+
+
+# Plugins (previously gems:)
+plugins:
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jekyll-include-cache
+
+# mimic GitHub Pages with --safe
+whitelist:
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jekyll-include-cache
+
+
+# Archives
+#  Type
+#  - GitHub Pages compatible archive pages built with Liquid ~> type: liquid (default)
+#  - Jekyll Archives plugin archive pages ~> type: jekyll-archives
+#  Path (examples)
+#  - Archive page should exist at path when using Liquid method or you can
+#    expect broken links (especially with breadcrumbs enabled)
+#  - <base_path>/tags/my-awesome-tag/index.html ~> path: /tags/
+#  - <base_path>/categories/my-awesome-category/index.html ~> path: /categories/
+#  - <base_path>/my-awesome-category/index.html ~> path: /
+category_archive:
+  type: liquid
+  path: /categories/
+tag_archive:
+  type: liquid
+  path: /tags/
+# https://github.com/jekyll/jekyll-archives
+# jekyll-archives:
+#   enabled:
+#     - categories
+#     - tags
+#   layouts:
+#     category: archive-taxonomy
+#     tag: archive-taxonomy
+#   permalinks:
+#     category: /categories/:name/
+#     tag: /tags/:name/
+
+
+# HTML Compression
+# - https://jch.penibelst.de/
+compress_html:
+  clippings: all
+  ignore:
+    envs: development
+

data/_pages/404.html

@@ -0,0 +1,26 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>This is not the page you are looking for...</strong></p>
+  <p>The requested page could not be found.</p>
+  <p>Please check your URL or head to the <a href="https://creek-service.github.io">landing page</a></p>
+</div>

data/robots.txt

@@ -0,0 +1 @@
+Sitemap: https://www.creekservice.org/sitemap.xml

data/sitemap.xml

@@ -0,0 +1,19 @@
+---
+layout: null
+---
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    {% assign pages = site.html_pages | where_exp:'doc','doc.url != "/404.html"' %}
+    {% for page in pages %}
+    <url>
+        {% if page.url == '/' %}
+        <loc>{{ page.url | replace:'/index.html','/' | absolute_url | xml_escape }}</loc>
+        {% else %}
+        <loc>{{ page.url | replace:'/index.html','/' | absolute_url | append: '.html' | xml_escape }}</loc>
+        {% endif %}
+        {% if page.last_modified_at %}
+        <lastmod>{{ page.last_modified_at | date_to_xmlschema }}</lastmod>
+        {% endif %}
+    </url>
+    {% endfor %}
+</urlset>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: creek-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Creek Service - Big Andy Coates
@@ -100,6 +100,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-algolia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: jemoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -135,10 +163,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
-- README.md
-- _data/README.md
-- _data/navigation.yml
+- LICENSE
+- _config.yml
 - _data/navigation/docs.yml
 - _data/navigation/main.yml
 - _data/ui-text.yml
@@ -212,6 +238,7 @@ files:
 - _layouts/splash.html
 - _layouts/tag.html
 - _layouts/tags.html
+- _pages/404.html
 - _sass/minimal-mistakes.scss
 - _sass/minimal-mistakes/_animations.scss
 - _sass/minimal-mistakes/_archive.scss
@@ -309,6 +336,9 @@ files:
 - assets/js/plugins/jquery.magnific-popup.js
 - assets/js/plugins/smooth-scroll.js
 - assets/js/vendor/jquery/jquery-3.6.0.js
+- favicon.ico
+- robots.txt
+- sitemap.xml
 homepage: https://github.com/creek-service/creek-jekyll-theme
 licenses:
 - MIT

data/README.md

@@ -1,81 +0,0 @@
-# creek-jekyll-theme
-
-The Jekyll theme used by the [Creek site](https://www.creekservice.org).
-
-## Installation
-
-Add this line to your Jekyll site's `Gemfile`:
-
-```ruby
-gem "creek-jekyll-theme"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: creek-jekyll-theme
-```
-
-And then execute:
-
-```shell
-$ bundle
-```
-
-Or install it yourself as:
-
-```shell
-$ gem install creek-jekyll-theme
-```
-## Usage
-
-The theme is a fork of [minimal-mistakes](https://github.com/mmistakes/minimal-mistakes), with a load of shared
-defaults, images, data, etc.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/creek-service/creek-jekyll-theme. 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
-to the [Contributor Covenant](https://www.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`. 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.
-
-When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
-To add a custom directory to your theme-gem, please edit the regexp in `creek-jekyll-theme.gemspec` accordingly.
-
-## License
-
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Releasing
-
-Manual process for now. Automation covered by [issue 1](https://github.com/creek-service/creek-jekyll-theme/issues/1)
-
-1. Update version number in the [gemspec](creek-jekyll-theme.gemspec).
-2. Commit & push
-   ```shell
-   git add -A
-   git commit -m "Bump release version"
-   git push 
-   ```
-3. Build the gem:
-   ```shell
-   gem build creek-jekyll-theme.gemspec
-   ```
-4. Release the gem:
-   ```shell
-   gem push creek-jekyll-theme-*.gem
-   ```
-
-### Dropping a release
-
-```shell
-gem yank creek-jekyll-theme -v VERSION_TO_DROP  
-```

data/_data/README.md

@@ -1,3 +0,0 @@
-Note: files in here will NOT be available when the theme is used as a GitHub pages remote theme :(
-
-See: https://github.com/github/pages-gem/pull/855

data/_data/navigation.yml

@@ -1,68 +0,0 @@
-# main links
-main:
-  - title: "Quick-Start Guide"
-    url: /docs/quick-start-guide/
-  - title: "About"
-    url: /about/
-  - title: "Sample Collections"
-    url: /collection-archive/
-  - title: "Terms & Privacy Policy"
-    url: /terms/
-
-
-# documentation links
-docs:
-  - title: Getting Started
-    children:
-      - title: "Quick-Start Guide"
-        url: /docs/quick-start-guide/
-      - title: "Structure"
-        url: /docs/structure/
-      - title: "Installation"
-        url: /docs/installation/
-      - title: "Upgrading"
-        url: /docs/upgrading/
-  - title: Customization
-    children:
-      - title: "Configuration"
-        url: /docs/configuration/
-      - title: "Overriding Theme Defaults"
-        url: /docs/overriding-theme-defaults/
-      - title: "Navigation"
-        url: /docs/navigation/
-      - title: "UI Text"
-        url: /docs/ui-text/
-      - title: "Authors"
-        url: /docs/authors/
-      - title: "Layouts"
-        url: /docs/layouts/
-  - title: Content
-    children:
-      - title: "Working with Posts"
-        url: /docs/posts/
-      - title: "Working with Pages"
-        url: /docs/pages/
-      - title: "Working with Collections"
-        url: /docs/collections/
-      - title: "Helpers"
-        url: /docs/helpers/
-      - title: "Utility Classes"
-        url: /docs/utility-classes/
-  - title: Extras
-    children:
-      - title: "Stylesheets"
-        url: /docs/stylesheets/
-      - title: "JavaScript"
-        url: /docs/javascript/
-  - title: Meta
-    children:
-      - title: "History"
-        url: /docs/history/
-      - title: "Contributing"
-        url: /docs/contributing/
-      - title: "Old 2.2 Docs"
-        url: /docs/docs-2-2/
-      - title: "License"
-        url: /docs/license/
-      - title: "Terms & Privacy Policy"
-        url: /terms/