r-jekyll-theme 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81eb3aacc7d93b1c168237111bcdf450877fba77c8be596f17a1bde6372eb023
+  data.tar.gz: 86e64a488e56534701fb25f3828048626d9bfbc82982f010eb8c27bd596813f0
+SHA512:
+  metadata.gz: 54f3e4655d3a28a1c78ea4e7c02f73f3ad26cef9cc58a5fa00d9ad86660d1fa23ffadace6d9e8a6567014e4e8287ca98f918eb4430b3c779890941e2e2c5f086
+  data.tar.gz: 7b70e5dbf4b3df1fb1cb192f14ab9d40a57bb33e8817260cb6d3456d3fab3a5b5073a32f774261cf60307667e22b2afa98be036dbe2c17926d57db062112e695

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 rafalkaron
+
+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,55 @@
+# r-jekyll-theme
+
+A simple red Jekyll theme perfect for portfolios and resumes.
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "r-jekyll-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: r-jekyll-theme
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install r-jekyll-theme
+
+## Usage
+
+### Data
+
+ * `contact.yml` - Edit this file to \
+
+#### meta.yml
+
+### Layouts
+
+### SASS
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rafalkaron/r-jekyll-theme. 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`. 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`, `_data` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `r.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_config.yml

@@ -0,0 +1,59 @@
+### Site metadata
+title: r
+author: Name Surname
+description: Site description
+keywords: comma, separated, keywords
+since: 2020
+logo: "Red"
+
+### Contact data
+contact:
+  email: 
+    id: 'mail@domain.com'
+    href: 'mailto:'
+    title: 'Email'
+    icon: "assets/icons/email.svg"
+    icon_dark: "assets/icons/email_dark.svg"
+  github: 
+    id: 'github_id'
+    href: 'https://github.com/'
+    title: 'GitHub'
+    icon: "assets/icons/github.svg"
+    icon_dark: "assets/icons/github_dark.svg"
+  linkedin:
+    id: 'linkedin_id'
+    href: 'https://linkedin.com/in/'
+    title: 'LinkedIn'
+    icon: "assets/icons/linkedin.svg"
+    icon_dark: "assets/icons/linkedin_dark.svg"
+  twitter: 
+    id: 'twitter_id'
+    href: 'https://twitter.com/'
+    title: 'Twitter'
+    icon: "assets/icons/twitter.svg"
+    icon_dark: "assets/icons/twitter_dark.svg"
+  500px:
+    id: '500px_id'
+    href: 'https://500px.com/'
+    title: '500px'
+    icon: "assets/icons/500px.svg"
+    icon_dark: "assets/icons/500px_dark.svg"
+
+### Site configuration
+livereload: true
+exclude: 
+  - LICENSE
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+markdown: kramdown
+kramdown:
+  input: GFM
+
+### github-pages-remote theme
+plugins:
+ - jekyll-remote-theme
+remote_theme: rafalkaron/r-jekyll-theme@main
+
+### Uncomment for gem-based theme
+#theme: r-jekyll-theme

data/_includes/content/multipage.html

@@ -0,0 +1,10 @@
+{% assign content = content | strip | replace: '<h1', '</article><article class="level-1"><h1' | remove_first: "</article>" %}
+{% assign content = content | strip | replace: '<h2', '</section><section class="level-2"><h2' | remove_first: "</section>" %}
+{% assign content = content | strip | replace: '<h3', '</section><section class="level-3"><h3' %}
+{% assign content = content | strip | replace: '<h4', '</section><section class="level-4"><h4' %}
+{% assign content = content | strip | replace: '<h5', '</section><section class="level-5"><h5' %}
+{% assign content = content | strip | replace: '<h6', '</section><section class="level-6"><h6' %}
+
+{{ content }}
+
+</article>

data/_includes/content/singlepage.html

@@ -0,0 +1,7 @@
+{% assign content_pages = site.pages | where: "layout", "singlepage" | sort: "order" %}
+{% for p in content_pages %}
+<section class="section" id="{{p.title | slugify}}">
+    {{- p.content | markdownify -}}
+</section>
+
+{% endfor %}

data/_includes/footer.html

@@ -0,0 +1,17 @@
+
+
+<footer id="site-footer">
+    <div class="footer-column footer-contact">
+        {%- if site.contact %}
+            {%- assign con = site.contact -%}
+            {%- for entry in con -%}
+                {%- assign key = entry | first -%}
+                {% if con[key].id %}
+            <a target="blank" class="footer-image-link" href="{{ con[key].href }}{{ con[key].id }}" title="{{ con[key].title }}"><img class="footer-icon" src="{{ con[key].icon }}"></a>
+                {%- endif -%}
+            {% endfor %}
+        {%- endif %}
+    </div>
+    <div class="footer-column footer-copyright">Copyright © {{site.since}}-{{ 'now' | date: "%Y" }} <a class="footer-link" href="{{site.email.href}}{{site.email.id}}" target="blank">{{site.author}}</a>.</div>
+</footer>
+

data/_includes/glossary.md

@@ -0,0 +1,21 @@
+*[SMEs]: Subject Matter Experts
+*[SME]: Subject Matter Expert
+*[DITA]: Darwin Information Typing Architecture
+*[GUI]: Graphical User Interface
+*[CLI]: Command Line Interface
+*[CCMS]: Component Content Management System
+*[Kanban]: An Agile framework focused on balancing demands with available capacity and handling bottlenecks.
+*[Scrum]: An Agile framework that aims at completing planned items within a fixed timeframe.
+*[Agile]: A work framework that involves self-organizing and cross-functional teams.
+*[WMS]: Work Management System
+*[XSLT]: Extensible Stylesheet Language Transformations
+*[UX]: User Experience
+*[UI]: User Interface
+*[AC]: Acceptance Criteria
+*[STR]: Steps to Reproduce
+*[RAW]: Unprocessed image
+*[QA]: Quality Assurance
+*[SaaS]: Software as a Service
+*[RFP]: Request for Proposal
+*[RFI]: Request for Information
+*[RFQ]: Request for Quotation

data/_includes/head.html

@@ -0,0 +1,20 @@
+
+
+<head>
+    {%- assign title = page.title -%}
+    {%- if site.title -%}
+        {% assign title = site.title | append: " | " | append: page.title %}
+    {%- endif -%}
+    {% if page.title == nil %}
+        {% assign title = site.title | append: " | " | append: "404" %}
+    {% endif %}
+    <title>{{ title }}</title>
+    <meta charset="utf-8">
+    <meta name="author" content="{{ site.author }}">
+    <meta name="description" content="{{ site.description }}">
+    <meta name="keywords" content="{{ site.keywords }}">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover">
+    <link rel="icon" type="image/ico" href="assets/favicon.svg">
+    <link rel="stylesheet" href="assets/main.css">
+</head>

data/_includes/header.html

@@ -0,0 +1,24 @@
+
+
+<header id="site-header" role="banner">    
+    <div id="site-logo-container">
+        {%- if site.logo %}
+        <a href="index.html" id="site-logo">{{ site.logo }}</a>
+        {%- endif %}
+    </div>
+
+    <nav id="site-nav">
+        <div id="site-nav-page">
+            <div id="toc-pages">
+                {% include toc/pages.html -%}
+            </div>
+        </div>
+        <div id="site-nav-section">
+            <h1 class="print print-header">Contents</h1>
+            <div id="toc-sections">
+                {% include toc/sections.html html=content anchor_class="nav-link" h_min=1 h_max=1 sanitize=true %}
+            </div>
+        </div>
+    </nav>
+</header>
+

data/_includes/print/cover_back.html

@@ -0,0 +1,20 @@
+<div class="print" id="cover-back">
+    <div id="cover-back-content">
+
+            <div class="footer-column footer-contact">
+                <h1 class="print-header">Contact</h1>
+                {%- if site.contact %}
+                    {%- assign con = site.contact -%}
+                    <ul>
+                    {%- for entry in con -%}
+                        {%- assign key = entry | first -%}
+                        {% if con[key].id %}
+                        <li><img class="footer-icon" src="{{ con[key].icon_dark }}"><a target="blank" class="footer-image-link" href="{{ con[key].href }}{{ con[key].id }}" title="{{ con[key].title }}">{{ con[key].href | remove_first: 'mailto:' | remove_first: 'https://' }}{{ con[key].id }}</a></li>
+                        {%- endif -%}
+                    {% endfor %}
+                    </ul>
+                {%- endif %}
+            </div>
+        
+    </div>
+</div>

data/_includes/print/cover_front.html

@@ -0,0 +1,12 @@
+<div class="print" id="cover-front">
+    <div id="cover-front-content">
+        {%- if site.logo %}
+            <a target="blank" href="index.html" id="site-logo">{{ site.logo }}</a>
+        {%- endif %}
+        <div id="site-reference-container">
+            <a target="blank" id="site-reference" href="index.html">rafalkaron.github.io</a>
+            <div class="footer-column copyright">Copyright © {{site.since}}-{{ 'now' | date: "%Y" }} <a class="footer-link" href="{{site.email.href}}{{site.email.id}}" target="blank">{{site.author}}</a>.</div>        
+        </div>
+
+    </div>
+</div>

data/_includes/print/print_button.html

@@ -0,0 +1 @@
+<input id="print-button" class="screen" type="button" value="Print {{ page.title }}" onClick="window.print()">

data/_includes/toc/pages.html

@@ -0,0 +1,21 @@
+{%- assign default_paths = site.pages | where: "layout", "default" | sort: "order" | map: "path" -%}
+{%- assign page_paths = site.header_pages | default: default_paths -%}
+
+
+<ul class="{{ page.title | slugify }}">
+    {%- for path in page_paths %}
+        {%- assign toc_page = site.pages | where: "path", path | first -%}
+        {%- assign link_title = toc_page.title -%}
+        {%- if toc_page.navtitle -%}
+            {% assign link_title = toc_page.navtitle %}
+        {% endif %}
+    <li><a href="{{ toc_page.url | relative_url }}" class="nav-link {{ toc_page.title | slugify }}">{{ link_title | escape }}</a></li>
+    {%- endfor %}
+</ul>
+
+<style>
+    ul.{{ page.title | slugify }} a.{{ page.title | slugify }} {
+        text-decoration: underline;
+    }
+</style>
+

data/_includes/toc/sections.html

@@ -0,0 +1,170 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Copyright (c) 2017 Vladimir "allejo" Jimenez
+
+        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.
+    {% endcomment %}
+    {% comment %}
+        Version 1.0.14
+          https://github.com/allejo/jekyll-toc
+
+        "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
+
+        Usage:
+            {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
+
+        Parameters:
+            * html         (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+        Optional Parameters:
+            * sanitize      (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
+            * class         (string) :   ''   - a CSS class assigned to the TOC
+            * id            (string) :   ''   - an ID to assigned to the TOC
+            * h_min         (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
+            * h_max         (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
+            * ordered       (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
+            * item_class    (string) :   ''   - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level
+            * submenu_class (string) :   ''   - add custom class(es) for each child group of headings; has support for '%level%' placeholder which is the current "submenu" heading level
+            * baseurl       (string) :   ''   - add a base url to the TOC links for when your TOC is on another page than the actual content
+            * anchor_class  (string) :   ''   - add custom class(es) for each anchor element
+            * skipNoIDs     (bool)   : false  - skip headers that do not have an `id` attribute
+
+        Output:
+            An ordered or unordered list representing the table of contents of a markdown block. This snippet will only
+            generate the table of contents and will NOT output the markdown given to it
+    {% endcomment %}
+
+    {% capture my_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign skipNoIDs = include.skipNoIDs | default: false %}
+    {% assign minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+    {% assign previousLevel = 0 %}
+
+    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if headerLevel < minHeader or headerLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign html_id = _idWorkspace[0] %}
+
+        {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
+        {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
+        {% assign html_class = _classWorkspace[0] %}
+
+        {% if html_class contains "no_toc" %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader %}
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% if include.item_class and include.item_class != blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endif %}
+
+        {% capture anchor_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
+        {% capture anchor_body %}{{ anchor_body | replace: "|", "\|" }}{% endcapture %}
+
+        {% if html_id %}
+            {% capture list_item %}[{{ anchor_body }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% endcapture %}
+        {% elsif skipNoIDs == true %}
+            {% continue %}
+        {% else %}
+            {% capture list_item %}{{ anchor_body }}{% endcapture %}
+        {% endif %}
+
+        <!--
+        If we have a submenu class and we're unindenting, then we need to add a "closing" class to this group of bullet
+        points
+        -->
+        {% if include.submenu_class and previousLevel > indentAmount %}
+            <!--
+            `space` is the current indentation, so we if want to close off the previous grouping, we need to add one
+            more level of indentation 
+            -->
+            {% assign submenuIndentation = space | prepend: '    ' %}
+
+            {% capture my_toc %}{{ my_toc }}
+{{ submenuIndentation }}{:.{{ include.submenu_class | replace: '%level%', previousLevel }}}{% endcapture %}
+        {% endif %}
+
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} {{ list_item }}{% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
+
+        {% assign previousLevel = indentAmount %}
+    {% endfor %}
+
+    {% if include.class and include.class != blank %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    <!--
+    If we have a submenu class, we need to close off all the remaining list item groups so that submenu classes are
+    applied correctly to them
+    -->
+    {% if include.submenu_class != blank %}
+        <!-- The last level of indentation that we were at, we need to work backwards from there closing each group -->
+        {% for i in (1..previousLevel) %}
+            {% assign lvl = previousLevel | plus: 1 | minus: i %} <!-- Invert the indent level based on `i` -->
+            {% assign closingSpace = '' %}
+
+            {% for i in (1..lvl) %}
+                {% assign closingSpace = closingSpace | prepend: '    ' %}
+            {% endfor %}
+
+            {% capture my_toc %}{{ my_toc }}
+{{ closingSpace }}{:.{{ include.submenu_class | replace: '%level%', lvl }}}{% endcapture %}
+        {% endfor %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}