jekyll-rtd-theme 2.0.0.pre.beta → 2.0.0.pre.beta1

data/_includes/head/script.liquid

@@ -0,0 +1,16 @@
+<script>
+    window.ui = {
+        title: "{{ site.title }}",
+        lang: "{{ site.lang }}",
+        version: "{{ version }}",
+        baseurl: "{{ site.baseurl }}",
+        i18n: {
+            search_docs: "{{ __.search_docs | default: 'Search Docs' }}",
+            search_results: "{{ __.search_results | default: 'Search Results' }}",
+            search_results_found: "{{ __.search_results_found | default: 'Search finished, found # page(s) matching the search query.' }}",
+            search_results_not_found: "{{ __.search_results_not_found | default: 'Your search did not match any documents, please make sure that all characters are spelled correctly!' }}"
+        }
+    };
+</script>
+<script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+<script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/head/script.schema.liquid

@@ -0,0 +1,27 @@
+<script type="application/ld+json">
+    {
+        "@context": "https://schema.org",
+        "@type": "Article",
+        "mainEntityOfPage": {
+            "@type": "WebPage",
+            "@id": "{{ schema_surl }}"
+        },
+        "headline": "{{ title }}",
+        "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
+        "author": {
+            "@type": "Person",
+            "name": "{{ author }}"
+        },
+        "datePublished": "{{ schema_date }}",
+        "dateModified": "{{ schema_modi }}",
+        "publisher": {
+            "@type": "{{ docs.owner.type }}",
+            "name": "{{ author }}",
+            "logo": {
+                "@type": "ImageObject",
+                "url": "{{ docs.owner.avatar_url }}"
+            }
+        },
+        "description": "{{ description }}"
+    }
+</script>

data/_includes/head/title.liquid

@@ -0,0 +1 @@
+<title>{{ title }}</title>

data/_includes/{extend/list.liquid → list.extend.liquid}

@@ -1,15 +1,15 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/workdir.liquid -%}
+{%- include assets/site_pages.liquid -%}
+{%- include assets/workdir.liquid -%}
 
 {%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
 {%- assign size = workdir_level | minus: base -%}
 {%- assign size_p1 = size | plus: 1 -%}
 
 {%- assign dir = site_pages | where: "url", workdir | first %}
-{% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
+{% include assets/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
 
 {%- for item in workdir_files %}
-{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
+{% include assets/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
-{%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
+{%- for workdir in workdir_dirs %}{% include list.extend.liquid %}{% endfor -%}

data/_includes/list.liquid

@@ -1,10 +1,10 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/workdir.liquid workdir=page.dir -%}
+{%- include assets/site_pages.liquid -%}
+{%- include assets/workdir.liquid workdir=page.dir -%}
 
 {%- for item in workdir_files %}
 - [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- if include.all -%}
-    {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
+    {%- for workdir in workdir_dirs %}{% include list.extend.liquid %}{% endfor -%}
 {%- endif -%}

data/_includes/shortcodes/danger.liquid

@@ -1,7 +1,9 @@
-<div class="admonition danger">
-    <p class="admonition-title" ui="danger">
-        <i class="fas fa-exclamation-circle"></i>
-        <span class="progress"></span>
-    </p>
-    {{ codes | markdownify | strip_newlines -}}
+<div class="admonition danger box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.danger | default: "Danger" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
 </div>

data/_includes/shortcodes/note.liquid

@@ -1,7 +1,9 @@
-<div class="admonition note">
-    <p class="admonition-title" ui="note">
-        <i class="fas fa-exclamation-circle"></i>
-        <span class="progress"></span>
-    </p>
-    {{ codes | markdownify | strip_newlines -}}
+<div class="admonition note box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.note | default: "Note" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
 </div>

data/_includes/shortcodes/tip.liquid

@@ -1,7 +1,9 @@
-<div class="admonition tip">
-    <p class="admonition-title" ui="tip">
-        <i class="fas fa-exclamation-circle"></i>
-        <span class="progress"></span>
-    </p>
-    {{ codes | markdownify | strip_newlines -}}
+<div class="admonition tip box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.tip | default: "Tip" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
 </div>

data/_includes/shortcodes/warning.liquid

@@ -1,7 +1,9 @@
-<div class="admonition warning">
-    <p class="admonition-title" ui="warning">
-        <i class="fas fa-exclamation-circle"></i>
-        <span class="progress"></span>
-    </p>
-    {{ codes | markdownify | strip_newlines -}}
+<div class="admonition warning box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.warning | default: "Warning" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
 </div>

data/_layouts/default.liquid

@@ -2,191 +2,23 @@
 layout: plugins/compress
 ---
 
-{%- include reset/defaults.liquid -%}
+{%- include assets/defaults.liquid -%}
 
 <!DOCTYPE html>
 <html lang="{{ site.lang }}">
-
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
-    <meta content="IE=Edge" http-equiv="X-UA-Compatible">
-    <title>{{ title | truncate: 110 }}</title>
-    <!-- meta -->
-    <meta name="description" content="{{ description }}">
-    <meta name="author" content="{{ site.github.owner_name }}">
-    <meta name="revised" content="{{ site.github.build_revision }}">
-    <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
-    <!-- meta-ogp -->
-    {% comment %} https://ogp.me {% endcomment %}
-    <meta property="og:title" content="{{ title }}">
-    <meta property="og:description" content="{{ description }}">
-    <meta property="og:locale" content="{{ site.lang }}">
-    <meta property="og:url" content="{{ schema_surl }}">
-    <meta property="og:type" content="article">
-    <meta property="article:author" content="{{ site.github.owner_name }}">
-    <meta property="article:published_time" content="{{ schema_date }}">
-    <meta property="article:modified_time" content="{{ schema_modi }}">
-    <!-- meta-custom -->
-    {% for meta in site.meta -%}
-        <meta name="{{ meta.first }}" content="{{ meta.last }}">
-    {% endfor -%}
-    <!-- schema -->
-    <script type="application/ld+json">
-        {
-            "@context": "https://schema.org",
-            "@type": "Article",
-            "mainEntityOfPage": {
-                "@type": "WebPage",
-                "@id": "{{ schema_surl }}"
-            },
-            "headline": "{{ title | truncate: 110 }}",
-            "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
-            "author": {
-                "@type": "Person",
-                "name": "{{ site.github.owner_name }}"
-            },
-            "datePublished": "{{ schema_date }}",
-            "dateModified": "{{ schema_modi }}",
-            "publisher": {
-                "@type": "Organization",
-                "name": "RunDocs",
-                "logo": {
-                    "@type": "ImageObject",
-                    "url": "https://rundocs.io/logo.png"
-                }
-            },
-            "description": "{{ description }}"
-        }
-    </script>
-    <!-- link -->
-    <link rel="canonical" href="{{ schema_surl }}">
-    {% if prev %}<link rel="prev" href="{{ prev.url | absolute_url }}">{% endif %}
-    {% if next %}<link rel="next" href="{{ next.url | absolute_url }}">{% endif %}
-    <!-- theme -->
-    <link rel="stylesheet" href="{{ cdn }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
-    <!-- icon -->
-    <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">
-    <!-- script -->
-    <script>
-        window.ui = {
-            baseurl: "{{ site.baseurl }}",
-            title: "{{ site.title }}",
-            admonition: {
-                note: "{{ __note }}",
-                tip: "{{ __tip }}",
-                warning: "{{ __warning }}",
-                danger: "{{ __danger }}"
-            },
-            lang: "{{ site.lang }}",
-            version: "{{ version }}"
-        };
-    </script>
-    <!-- script -->
-    <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
-    <script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>
-
-</head>
-
-<body class="container">
-    <div class="sidebar-wrap overflow-hidden">
-        <div class="sidebar d-flex flex-column height-full overflow-y-scroll overflow-x-hidden">
-            <div class="header d-flex flex-column p-3 text-center">
-                <div class="title pb-1 no-underline">
-                    <a class="h4 py-1 px-2 rounded-1" href="{{ site.baseurl }}/">
-                        {% if site.logo %}
-                            <img class="logo" src="{{ site.baseurl }}/{{ site.logo }}" alt="{{ site.title }}">
-                        {% else %}
-                            <i class="fa fa-home"></i> {{ site.title }}
-                        {% endif %}
-                    </a>
-                </div>
-                <span class="version text-gray">{{ site.github.latest_release.name }}</span>
-                <form class="search pt-2" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
-                    <input class="form-control input-block input-sm" type="text" name="q" placeholder="{{ site.data.translate.search_docs | default: 'Search docs' }}...">
-                </form>
-            </div>
-            <div class="toctree py-2" data-spy="affix" role="navigation" aria-label="main navigation">
-                {% include toctree.liquid %}
-            </div>
-            <div class="embed-wrap">
-                <div class="embed p-2 m-3 rounded-2 text-blue bg-white">
-                    {{ site.embed }}
-                </div>
-            </div>
-        </div>
-    </div>
-    <div class="content-wrap">
-        <div class="header d-flex flex-justify-between p-2 hide-lg hide-xl" aria-label="top navigation">
-            <button id="toggle" class="btn-octicon p-2 m-0 text-white" type="button">
-                <i class="fa fa-bars"></i>
-            </button>
-            <div class="title flex-1 no-underline d-flex flex-justify-center">
-                <a class="h4 py-1 px-2 rounded-1" href="{{ site.baseurl }}/">{{ site.title }}</a>
-            </div>
-        </div>
-        <div class="content p-5">
-            {% include breadcrumbs.liquid %}
-            <hr>
-            <div role="main" itemscope="itemscope" itemtype="http://schema.org/Article">
-                <div class="markdown-body" itemprop="articleBody">
-                    {{ content }}
-                </div>
-            </div>
-            {% include footer.liquid %}
-        </div>
-    </div>
-    <div class="addons-wrap d-flex flex-column overflow-y-auto">
-        <div class="status d-flex flex-justify-between p-2">
-            <div class="title p-1">
-                <i class="fa fa-book"></i> {{ site.title }}
-            </div>
-            <div class="branch p-1">
-                <span class="name">
-                    {{ site.github.source.branch }}
-                </span>
-                <i class="fa fa-caret-down"></i>
-            </div>
-        </div>
-        <div class="addons d-flex flex-column height-full p-2 d-none">
-            {%- assign items = "github, analytics" | split: ", " -%}
-            {% for item in items -%}
-                {% include addons/{{ item }}.liquid %}
-            {% endfor -%}
-            <hr>
-            <div class="generator f6 pb-2">
-                Built with
-                <a href="https://github.com/rundocs/jekyll-rtd-theme" target="_blank" title="{% if site.remote_theme %}remote{% endif %} theme v{{ version }}">jekyll-rtd-theme</a>
-                provided by
-                <a href="https://rundocs.io" target="_blank">RunDocs</a>
-            </div>
-        </div>
-    </div>
-
-    {%- comment %} mermaid {% endcomment -%}
-    {%- if content contains '<code class="language-mermaid">' -%}
-        {%- if site.mermaid.custom -%}
-            <script src="{{ site.mermaid.custom }}"></script>
-        {%- else -%}
-            <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
-        {%- endif %}
-        <script>
-            mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
-        </script>
-    {%- endif %}
-
-    {% comment %} Google Analytics {% endcomment %}
-    {%- if site.google.gtag -%}
-        <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
-        <script>
-            window.dataLayer = window.dataLayer || [];
-            function gtag() {
-                dataLayer.push(arguments);
-            }
-            gtag("js", new Date());
-            gtag("config", "{{ site.google.gtag }}");
-        </script>
-    {%- endif -%}
-</body>
-
+    <head>
+        {%- include head/metadata.liquid -%}
+
+        {%- include head/title.liquid -%}
+        {%- include head/links.liquid -%}
+
+        {%- include head/script.schema.liquid -%}
+        {%- include head/script.liquid -%}
+        {%- include head/script.extension.liquid -%}
+    </head>
+    <body class="container">
+        {%- include class/sidebar-wrap.liquid -%}
+        {%- include class/addons-wrap.liquid  -%}
+        {%- include class/content-wrap.liquid -%}
+    </body>
 </html>

data/_layouts/plugins/extension.liquid

@@ -1,4 +1,6 @@
-{%- include safe/shortcodes.liquid -%}
+{%- include assets/i18n.liquid -%}
+
+{%- assign shortcodes = "mermaid, warning, note, tip, danger" | split: ", " -%}
 
 {%- if site.debug.extension == false -%}
     {{ content }}

data/_sass/_icons.scss

@@ -51,3 +51,7 @@
 .fa-copyright:before {
   content: "\f1f9";
 }
+
+.fa-exclamation-circle:before {
+  content: "\f06a";
+}

data/_sass/_layout.scss

@@ -34,7 +34,7 @@
   }
 }
 
-@media screen and (min-width: $width-md) {
+@include breakpoint(md) {
   .menu-md {
     left: 0;
     width: $theme-menu-width;
@@ -47,8 +47,7 @@
       width: $theme-menu-width + 20px;
 
       .header,
-      .toctree,
-      .embed-wrap {
+      .toctree {
         width: $theme-menu-width;
       }
     }
@@ -69,7 +68,7 @@
   }
 }
 
-@media screen and (min-width: $width-xl) {
+@include breakpoint(xl) {
   .content-wrap {
     max-width: $width-xl - $theme-menu-width;
   }

data/_sass/_variables.scss

@@ -1,29 +1,32 @@
-/* fonts */
+// fonts
 $body-font: "Lato", sans-serif;
 $mono-font: monospace;
 $head-font: "Roboto-Slab", sans-serif;
 
-/* reset */
+// reset
 $box-shadow-focus: none;
 
-/* theme color */
+// theme color
 $theme-blue: #2980b9;
-$theme-red: #e74c3c;
+$theme-red: #e74c3c; // code
+$theme-offgreen: #1abc9c;
+$theme-orange: #e67e22;
+
 $theme-white: lighten($black, 99%);
 $theme-black: lighten($black, 15%);
 
-/* theme link */
+// theme link
 $theme-link: $blue;
 $theme-link-hover: lighten($blue, 10%);
 $theme-link-visited: lighten($purple, 10%);
 
-/* theme code */
+// theme code
 
-/* theme mask */
+// theme mask
 $theme-mask-white: transparentize($theme-white, 0.9);
 $theme-mask-black: transparentize($theme-black, 0.9);
 
-/* theme menu */
+// theme menu
 $theme-menu-width: 300px;
 $theme-menu-background: darken($theme-black, 10%);
 $theme-menu-active-background: darken($theme-blue, 20%);

data/_sass/class/admonition.scss

@@ -0,0 +1,47 @@
+.admonition {
+  // fixed note
+  font-size: $h4-size;
+
+  // fixed
+  .content {
+    :first-child {
+      margin-top: 0;
+    }
+
+    :last-child {
+      margin-bottom: 0;
+    }
+  }
+
+  &.note {
+    background-color: lighten($theme-blue, 50%);
+
+    .title {
+      background: lighten($theme-blue, 20%);
+    }
+  }
+
+  &.tip {
+    background-color: lighten($theme-offgreen, 50%);
+
+    .title {
+      background: lighten($theme-offgreen, 0%);
+    }
+  }
+
+  &.warning {
+    background-color: lighten($theme-orange, 40%);
+
+    .title {
+      background: lighten($theme-orange, 20%);
+    }
+  }
+
+  &.danger {
+    background-color: lighten($theme-red, 40%);
+
+    .title {
+      background: lighten($theme-red, 20%);
+    }
+  }
+}