jekyll-theme-warpcore 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fcfd7b1e983d8229143b4941ca38b123844c369c77ab7600ed642bebad9d73c
+  data.tar.gz: '0258d5b3354f43e5797e766d6fdf35ec9be378871fa7e07681d288469603399b'
+SHA512:
+  metadata.gz: 6d9d67d0a7d74f60406c8ee571c1b6e1be7b69bc053de8584ecd3cdfdcdad2210cc7912bf7add008a97e50fe07690b1aa8fabb18029d876856602576d21ba798
+  data.tar.gz: 0e9776947087f41200a62f394230dc9f8f9994ec60698bb855a949085af8fa867a554d3a61ac237c1b383b2217338f27f8ba4fbfd31165aef42b6ca2b0bfa6b4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Chris
+
+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,29 @@
+# Warpcore theme
+
+_Warpcore_ is a Jekyll theme for Github Pages. You can [preview the theme here](https://linklord.github.io/warpcore/).
+
+## Usage
+
+To use the Warpcore theme:
+
+Add the following to your site's \_config.yml:
+
+```yml
+remote_theme: linklord/warpcore
+```
+
+Optionally, if you'd like to preview your site on your computer, add the following to your site's Gemfile:
+
+```rb
+gem "github-pages", group: :jekyll_plugins
+```
+
+## Preview the theme locally
+
+If you'd like to preview the theme locally:
+
+1. Clone down the theme's repository (git clone https://github.com/linklord/warpcore)
+2. `cd` into the theme's directory
+3. Run `script/bootstrap` to install the necessary dependencies
+4. Run `bundle exec jekyll serve` to start the preview server
+5. Visit [localhost:4000](http://localhost:4000) in your browser to preview the theme

data/_data/nav.yml

@@ -0,0 +1,7 @@
+- title: Formatting
+- title: Installation
+- title: Configuration
+  pages:
+    - title: Navigation
+    - title: Mathjax
+    - title: Docsearch

data/_includes/docsearch.html

@@ -0,0 +1,15 @@
+<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
+<script>
+  docsearch({
+    // Your apiKey and indexName will be given to you once
+    // we create your config
+    apiKey: '{{ site.docsearch.search_only_api_key }}',
+    indexName: '{{ site.docsearch.index_name }}',
+    appId: '{{ site.docsearch.application_id }}', // Should be only included if you are running DocSearch on your own.
+    // Replace inputSelector with a CSS selector
+    // matching your search input
+    inputSelector: '#search-input',
+    // Set debug to true to inspect the dropdown
+    debug: false,
+  });
+</script>

data/_includes/footer-links.html

@@ -0,0 +1,120 @@
+{%- assign prev_page = nil -%}
+{%- assign prev_page_group = nil -%}
+{%- assign next_page = nil -%}
+{%- assign next_page_group = nil -%}
+
+{%- assign page_slug = page.url | split: '/' | last -%}
+
+{%- for group in site.data.nav -%}
+    {%- assign group_first = forloop.first -%}
+    {%- assign group_last = forloop.last -%}
+    {%- assign group_index = forloop.index0 -%}
+    {%- assign group_slug = group.title | slugify -%}
+    {%- if page.group == group_slug -%}
+        {%- if group.pages == nil -%}
+            {%- if group_first == false -%}
+                {%- assign prev_group_index = group_index | minus: 1 -%}
+                {%- if site.data.nav[prev_group_index].pages != nil -%}
+                    {%- assign prev_page_item = site.data.nav[prev_group_index].pages | last -%}
+                    {%- assign prev_page = prev_page_item.title -%}
+                    {%- assign prev_page_group = site.data.nav[prev_group_index].title -%}
+                {%- else -%}
+                    {%- assign prev_page_group = site.data.nav[prev_group_index].title -%}
+                {%- endif -%}
+            {%- endif -%}
+            {%- if forloop.last != true -%}
+                {%- assign next_index = forloop.index0 | plus: 1 -%}
+                {%- if site.data.nav[next_index].pages != nil -%}
+                    {%- assign next_page = site.data.nav[next_index].pages[0].title -%}
+                    {%- assign next_page_group = site.data.nav[next_index].title -%}
+                {%- else -%}
+                    {%- assign next_page_group = site.data.nav[next_index].title -%}
+                {%- endif -%}
+            {%- endif -%}
+        {%- else -%}
+            {%- for doc in group.pages -%}
+                {%- assign doc_slug = doc.title | slugify -%}
+                {%- if page_slug == doc_slug -%}
+                    {%- if forloop.first != true -%}
+                        {%- assign prev_index = forloop.index0 | minus: 1 -%}
+                        {%- assign prev_page = group.pages[prev_index].title -%}
+                        {%- assign prev_page_group = group.title -%}
+                    {%- else -%}
+                        {%- if group_first == false -%}
+                            {%- assign prev_group_index = group_index | minus: 1 -%}
+                            {%- if site.data.nav[prev_group_index].pages != nil -%}
+                                {%- assign prev_page_item = site.data.nav[prev_group_index].pages | last -%}
+                                {%- assign prev_page = prev_page_item.title -%}
+                                {%- assign prev_page_group = site.data.nav[prev_group_index].title -%}
+                            {%- else -%}
+                                {%- assign prev_page_group = site.data.nav[prev_group_index].title -%}
+                            {%- endif -%}
+                        {%- endif -%}
+                    {%- endif -%}
+                    {%- if forloop.last != true -%}
+                        {%- assign next_index = forloop.index0 | plus: 1 -%}
+                        {%- assign next_page = group.pages[next_index].title -%}
+                        {%- assign next_page_group = group.title -%}
+                    {%- else -%}
+                        {%- assign next_group_index = group_index | plus: 1 -%}
+                        {%- if site.data.nav[next_group_index].pages != nil -%}
+                            {%- assign next_page = site.data.nav[next_group_index].pages[0].title -%}
+                            {%- assign next_page_group = site.data.nav[next_group_index].title -%}
+                        {%- else -%}
+                            {%- assign next_page_group = site.data.nav[next_group_index].title -%}
+                        {%- endif -%}
+                    {%- endif -%}
+                {%- endif -%}
+            {%- endfor -%}
+        {%- endif -%}
+    {%- endif -%}
+{%- endfor -%}
+<footer class="wc-footer">
+<div class="row">
+    <div class="col wc-footer-prev">
+        {%- if prev_page_group -%}
+        {%- assign group_slug = prev_page_group | slugify -%}
+        {%- assign link_slug = prev_page | slugify -%}
+        {%- if prev_page -%}
+            {%- assign prev_text = prev_page -%}
+        {%- else -%}
+            {%- assign prev_text = prev_page_group -%}
+        {%- endif -%}
+
+        {%- if prev_page -%}
+        <small class="text-muted">{{ prev_page_group }}</small>
+        {%- else -%}
+        <small class="text-muted">Previous</small>
+        {%- endif -%}
+
+        <p class="lead"><a href="{{ site.baseurl }}/{{ group_slug }}/{{ link_slug }}{% if link_slug %}/{% endif %}">
+            &larr; {{ prev_text }}
+        </a></p>
+
+        {%- endif -%}
+    </div>
+    <div class="col wc-footer-next">
+        {%- if next_page_group -%}
+        {%- assign group_slug = next_page_group | slugify -%}
+        {%- assign link_slug = next_page | slugify -%}
+        {%- if next_page -%}
+            {%- assign next_text = next_page -%}
+        {%- else -%}
+            {%- assign next_text = next_page_group -%}
+        {%- endif -%}
+
+        {%- if next_page -%}
+        <small class="text-muted">{{ next_page_group }}</small>
+        {%- else -%}
+        <small class="text-muted">Next</small>
+        {%- endif -%}
+
+        <p class="lead"><a href="{{ site.baseurl }}/{{ group_slug }}/{{ link_slug }}{% if link_slug %}/{% endif %}">
+            {{ next_text }} &rarr;
+        </a></p>
+        {%- endif -%}
+    </div>
+</div>
+
+</footer>
+

data/_includes/mathjax.html

@@ -0,0 +1,25 @@
+{% if page.mathjax %}
+<script type="text/x-mathjax-config">
+  MathJax.Hub.Config({
+    tex2jax: {
+      inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+      processEscapes: true
+    }
+  });
+</script>
+<script type="text/javascript" async
+  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML">
+</script>
+<!-- <script
+  type="text/javascript"
+  charset="utf-8"
+  src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
+>
+</script> -->
+<!-- <script
+  type="text/javascript"
+  charset="utf-8"
+  src="https://vincenttam.github.io/javascripts/MathJaxLocal.js"
+>
+</script>
+ -->{% endif %}

data/_includes/menu.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg"{% if include.width %} width="{{ include.width }}"{% endif %}{% if include.height %} height="{{ include.height }}"{% endif %}{% if include.class %} class="{{ include.class }}"{% endif %} viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"/></svg>

data/_includes/scripts.html

@@ -0,0 +1,15 @@
+{% if site.google_analytics %}
+<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google_analytics }}"></script>
+<script>
+window.dataLayer = window.dataLayer || [];
+function gtag(){dataLayer.push(arguments);}
+gtag('js', new Date());
+gtag('config', '{{ site.google_analytics }}');
+</script>
+{% endif %}
+
+<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
+<script src="{{ 'assets/js/bootstrap.bundle.min.js' | relative_url }}"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
+<script>anchors.add('.wc-content > h2, .wc-content > h3, .wc-content > h4, .wc-content > h5')</script>

data/_includes/sidebar.html

@@ -0,0 +1,44 @@
+<div class="wc-sidebar-block">
+  <a class="wc-brand" href="{{ '/' | relative_url }}">{{ site.title }}</a>
+  <button class="btn btn-link wc-search-docs-toggle float-right d-md-none p-0 ml-3" type="button" data-toggle="collapse" data-target="#wc-docs-nav" aria-controls="wc-docs-nav" aria-expanded="false" aria-label="Toggle docs navigation">
+  {%- include menu.svg width="30" height="30" -%}
+</button>
+</div>
+{%- if site.docsearch -%}
+<div class="wc-docsearch">
+  <form role="search" class="d-flex align-items-center">
+  <input type="search" class="form-control" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off">
+  </form>
+</div>
+{%- endif -%}
+<nav class="collapse wc-links" id="wc-docs-nav" aria-label="Main navigation">
+  {%- assign page_slug = page.url | split: '/' | last -%}
+  {%- for group in site.data.nav -%}
+  {%- assign link = group.pages | first -%}
+  {%- assign link_slug = link.title | slugify -%}
+  {%- assign group_slug = group.title | slugify -%}
+  {%- assign active = nil -%}
+  {%- if page.group == group_slug -%}
+    {%- assign active = 'active' -%}
+  {%- endif -%}
+  <div class="wc-sidebar-item{% unless active == nil %} {{ active }}{% endunless %}">
+      <a class="wc-sidebar-link" href="{{ site.baseurl }}/{{ group_slug }}/{{ link_slug }}{% if link_slug %}/{% endif %}">
+        {{ group.title }}
+      </a>
+      <ul class="nav wc-sidenav">
+        {%- for doc in group.pages -%}
+          {%- assign doc_slug = doc.title | slugify -%}
+          {%- assign active = nil -%}
+          {%- if page.group == group_slug and page_slug == doc_slug -%}
+            {%- assign active = 'active wc-sidenav-active' -%}
+          {%- endif -%}
+          <li{% unless active == nil %} class="{{ active }}"{% endunless %}>
+            <a href="{{ site.baseurl }}/{{ group_slug }}/{{ doc_slug }}/">
+              {{ doc.title }}
+            </a>
+          </li>
+        {%- endfor -%}
+      </ul>
+    </div>
+  {%- endfor -%}
+</nav>

data/_includes/toc.html

@@ -0,0 +1,96 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.8
+          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
+            * 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
+
+        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 minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+
+    {% 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 %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader %}
+        {% 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 %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% unless include.item_class == blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endunless %}
+
+        {% capture heading_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} [{{ heading_body | replace: "|", "\|" }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
+    {% endfor %}
+
+    {% if include.class %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}

data/_layouts/default.html

@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  {% seo %}
+  <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" media="screen" type="text/css">
+	<!--[if lt IE 9]>
+	<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+	<![endif]-->
+  {%- if site.docsearch -%}
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"/>
+  {%- endif -%}
+</head>
+<body {% if page.toc %}class="position-relative" data-spy="scroll" data-target="#wc-toc-nav" data-offset="0"{% endif %}>
+<div class="container-fluid">
+  <div class="row flex-xl-nowrap">
+        <div class="col-md-3 col-xl-2 wc-sidebar">
+        {% include sidebar.html %}
+        </div>
+
+        {% if page.toc or page.toc == nil %}
+        <nav id="wc-toc-nav" class="d-none d-xl-block col-xl-2 wc-toc" aria-label="Secondary navigation">
+          {% include toc.html html=content class="nav.section-nav" anchor_class="nav-link" item_class="toc-entry.toc-h%level%" h_min=2 h_max=4 %}
+        </nav>
+        {% endif %}
+
+        <main class="wc-content col-md-9 col-xl-8 py-md-3 pl-md-5" role="main">
+          <h1 class="wc-title">{{ page.title }}</h1>
+          <p class="wc-lead">{{ page.description }}</p>
+          {{ content }}
+          {% unless page.group == nil %}
+          {% if page.footer_links or page.footer_links == nil %}
+          {% include footer-links.html %}
+          {% endif %}
+          {% endunless %}
+        </main>
+  </div>
+</div>
+
+{%- if site.docsearch -%}{% include docsearch.html %}{%- endif -%}
+{% include scripts.html %}
+{% include mathjax.html %}
+</body>
+</html>