doc-theme 0.1.0

data/assets/feed.xml

@@ -0,0 +1,61 @@
+---
+layout: compress
+permalink: /feed.xml
+# Atom Feed, reference: https://validator.w3.org/feed/docs/atom.html
+---
+
+{% capture source %}
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <id>{{ "/" | absolute_url }}</id>
+  <title>{{ site.title }}</title>
+  <subtitle>{{ site.description }}</subtitle>
+  <updated>{{ site.time | date_to_xmlschema }}</updated>
+  <author>
+    <name>{{ site.social.name }}</name>
+    <uri>{{ "/" | absolute_url }}</uri>
+  </author>
+  <link rel="self" type="application/atom+xml" href="{{ page.url | absolute_url }}"/>
+  <link rel="alternate" type="text/html" hreflang="{{ site.alt_lang | default: site.lang }}"
+    href="{{ '/' | absolute_url }}"/>
+  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
+  <rights> © {{ 'now' | date: '%Y' }} {{ site.social.name }} </rights>
+  <icon>{{ site.baseurl }}/assets/img/favicons/favicon.ico</icon>
+  <logo>{{ site.baseurl }}/assets/img/favicons/favicon-96x96.png</logo>
+
+{% for post in site.posts limit: 5 %}
+  {% assign post_absolute_url = post.url | absolute_url %}
+  <entry>
+    <title>{{ post.title }}</title>
+    <link href="{{ post_absolute_url }}" rel="alternate" type="text/html" title="{{ post.title | xml_escape }}" />
+    <published>{{ post.date | date_to_xmlschema }}</published>
+  {% if post.last_modified_at %}
+    <updated>{{ post.last_modified_at | date_to_xmlschema }}</updated>
+  {% else %}
+    <updated>{{ post.date | date_to_xmlschema }}</updated>
+  {% endif %}
+    <id>{{ post_absolute_url }}</id>
+    <content src="{{ post_absolute_url }}" />
+    <author>
+      <name>{{ post.author | default: site.social.name }}</name>
+    </author>
+
+  {% if post.categories %}
+    {% for category in post.categories %}
+    <category term="{{ category }}" />
+    {% endfor %}
+  {% endif %}
+
+  {% if post.summary %}
+    <summary>{{ post.summary | strip }}</summary>
+  {% else %}
+    <summary>
+      {% include no-linenos.html content=post.content %}
+      {{ content  | strip_html | truncate: 400 }}
+    </summary>
+  {% endif %}
+
+  </entry>
+{% endfor %}
+</feed>
+{% endcapture %}
+{{ source | replace: '&', '&amp;' }}

data/assets/img/favicons/browserconfig.xml

@@ -0,0 +1,13 @@
+---
+layout: compress
+---
+
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+  <msapplication>
+    <tile>
+      <square150x150logo src="{{ '/assets/img/favicons/mstile-150x150.png' | relative_url }}" />
+      <TileColor>#da532c</TileColor>
+    </tile>
+  </msapplication>
+</browserconfig>

data/assets/img/favicons/site.webmanifest

@@ -0,0 +1,26 @@
+---
+layout: compress
+---
+
+{% assign favicon_path = "/assets/img/favicons" | relative_url %}
+
+{
+  "name": "{{ site.title }}",
+  "short_name": "{{ site.title }}",
+  "description": "{{ site.description }}",
+  "icons": [
+    {
+      "src": "{{ favicon_path }}/android-chrome-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "{{ favicon_path }}/android-chrome-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }],
+  "start_url": "{{ '/index.html' | relative_url }}",
+  "theme_color": "#2a1e6b",
+  "background_color": "#ffffff",
+  "display": "fullscreen"
+}

data/assets/js/data/search.json

@@ -0,0 +1,20 @@
+---
+layout: compress
+swcache: true
+---
+
+[
+  {% for post in site.posts %}
+  {
+    "title": {{ post.title | jsonify }},
+    "url": {{ post.url | relative_url | jsonify }},
+    "categories": {{ post.categories | join: ', ' | jsonify }},
+    "tags": {{ post.tags | join: ', ' | jsonify }},
+    "date": "{{ post.date }}",
+    {% include no-linenos.html content=post.content %}
+    {% assign _content = content | strip_html | strip_newlines %}
+    "snippet": {{ _content | truncate: 200 | jsonify }},
+    "content": {{ _content | jsonify }}
+  }{% unless forloop.last %},{% endunless %}
+  {% endfor %}
+]

data/assets/js/data/swconf.js

@@ -0,0 +1,51 @@
+---
+layout: compress
+permalink: '/:path/swconf.js'
+# Note that this file will be fetched by the ServiceWorker, so it will not be cached.
+---
+
+const swconf = {
+  {% if site.pwa.cache.enabled %}
+    cacheName: 'doc-theme-{{ "now" | date: "%s" }}',
+
+    {%- comment -%} Resources added to the cache during PWA installation. {%- endcomment -%}
+    resources: [
+      '{{ "/assets/css/:THEME.css" | replace: ':THEME', site.theme | relative_url }}',
+      '{{ "/" | relative_url }}',
+      {% for tab in site.tabs %}
+        '{{- tab.url | relative_url -}}',
+      {% endfor %}
+
+      {% assign cache_list = site.static_files | where: 'swcache', true %}
+      {% for file in cache_list %}
+        '{{ file.path | relative_url }}'{%- unless forloop.last -%},{%- endunless -%}
+      {% endfor %}
+    ],
+
+    {%- comment -%} The request url with below domain will be cached. {%- endcomment -%}
+    allowHosts: [
+      {% if site.img_cdn and site.img_cdn contains '//' %}
+        '{{ site.img_cdn | split: '//' | last | split: '/' | first }}',
+      {% endif %}
+
+      {%- unless site.assets.self_host.enabled -%}
+       {% for cdn in site.data.origin["cors"].cdns %}
+          '{{ cdn.url | split: "//" | last }}'
+          {%- unless forloop.last -%},{%- endunless -%}
+        {% endfor %}
+      {% endunless %}
+    ],
+
+    {%- comment -%} The request url with below path will not be cached. {%- endcomment -%}
+    denyPaths: [
+      {% for path in site.pwa.cache.deny_paths %}
+        {% unless path == empty %}
+          '{{ path | relative_url }}'{%- unless forloop.last -%},{%- endunless -%}
+        {% endunless  %}
+      {% endfor %}
+    ],
+    purge: false
+  {% else %}
+    purge: true
+  {% endif %}
+};

data/assets/js/pwa/app.js

@@ -0,0 +1,54 @@
+---
+layout: compress
+permalink: /assets/js/dist/:basename.min.js
+---
+
+if ('serviceWorker' in navigator) {
+  const isEnabled = '{{ site.pwa.enabled }}' === 'true';
+
+  if (isEnabled) {
+    const swUrl = '{{ '/sw.min.js' | relative_url }}';
+    const $notification = $('#notification');
+    const $btnRefresh = $('#notification .toast-body>button');
+
+    navigator.serviceWorker.register(swUrl).then((registration) => {
+      {% comment %}In case the user ignores the notification{% endcomment %}
+      if (registration.waiting) {
+        $notification.toast('show');
+      }
+
+      registration.addEventListener('updatefound', () => {
+        registration.installing.addEventListener('statechange', () => {
+          if (registration.waiting) {
+            if (navigator.serviceWorker.controller) {
+              $notification.toast('show');
+            }
+          }
+        });
+      });
+
+      $btnRefresh.on('click', () => {
+        if (registration.waiting) {
+          registration.waiting.postMessage('SKIP_WAITING');
+        }
+        $notification.toast('hide');
+      });
+    });
+
+    let refreshing = false;
+
+    {% comment %}Detect controller change and refresh all the opened tabs{% endcomment %}
+    navigator.serviceWorker.addEventListener('controllerchange', () => {
+      if (!refreshing) {
+        window.location.reload();
+        refreshing = true;
+      }
+    });
+  } else {
+    navigator.serviceWorker.getRegistrations().then(function (registrations) {
+      for (let registration of registrations) {
+        registration.unregister();
+      }
+    });
+  }
+}

data/assets/js/pwa/sw.js

@@ -0,0 +1,101 @@
+---
+layout: compress
+permalink: /:basename.min.js
+# PWA service worker
+---
+
+const swconfUrl = '{{ '/assets/js/data/swconf.js' | relative_url }}';
+
+importScripts(swconfUrl);
+const purge = swconf.purge;
+
+function verifyHost(url) {
+  for (const host of swconf.allowHosts) {
+    const regex = RegExp(`^http(s)?://${host}/`);
+    if (regex.test(url)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+function verifyUrl(url) {
+  if (!verifyHost(url)) {
+    return false;
+  }
+
+  const requestPath = new URL(url).pathname;
+
+  for (const path of swconf.denyPaths) {
+    if (requestPath.startsWith(path)) {
+      return false;
+    }
+  }
+  return true;
+}
+
+if (!purge) {
+  swconf.allowHosts.push(location.host);
+}
+
+self.addEventListener('install', (event) => {
+  if (purge) {
+    return;
+  }
+
+  event.waitUntil(
+    caches.open(swconf.cacheName).then((cache) => {
+      return cache.addAll(swconf.resources);
+    })
+  );
+});
+
+self.addEventListener('activate', (event) => {
+  event.waitUntil(
+    caches.keys().then((keyList) => {
+      return Promise.all(
+        keyList.map((key) => {
+          if (purge) {
+            return caches.delete(key);
+          } else {
+            if (key !== swconf.cacheName) {
+              return caches.delete(key);
+            }
+          }
+        })
+      );
+    })
+  );
+});
+
+self.addEventListener('message', (event) => {
+  if (event.data === 'SKIP_WAITING') {
+    self.skipWaiting();
+  }
+});
+
+self.addEventListener('fetch', (event) => {
+  event.respondWith(
+    caches.match(event.request).then((response) => {
+      if (response) {
+        return response;
+      }
+
+      return fetch(event.request).then((response) => {
+        const url = event.request.url;
+
+        if (purge || event.request.method !== 'GET' || !verifyUrl(url)) {
+          return response;
+        }
+
+        {% comment %}See: <https://developers.google.com/web/fundamentals/primers/service-workers#cache_and_return_requests>{% endcomment %}
+        let responseToCache = response.clone();
+
+        caches.open(swconf.cacheName).then((cache) => {
+          cache.put(event.request, responseToCache);
+        });
+        return response;
+      });
+    })
+  );
+});

data/assets/robots.txt

@@ -0,0 +1,10 @@
+---
+permalink: /robots.txt
+# The robots rules
+---
+
+User-agent: *
+
+Disallow: /norobots/
+
+Sitemap: {{ '/sitemap.xml' | absolute_url }}

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: doc-theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- salarce
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jekyll-redirect-from
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: jekyll-seo-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: jekyll-archives
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: jekyll-sitemap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: jekyll-include-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description:
+email:
+- salarcedev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- _data/locales/ar.yml
+- _data/locales/bg-BG.yml
+- _data/locales/cs-CZ.yml
+- _data/locales/de-DE.yml
+- _data/locales/el-GR.yml
+- _data/locales/en.yml
+- _data/locales/es-ES.yml
+- _data/locales/fi-FI.yml
+- _data/locales/fr-FR.yml
+- _data/locales/hu-HU.yml
+- _data/locales/id-ID.yml
+- _data/locales/it-IT.yml
+- _data/locales/ko-KR.yml
+- _data/locales/my-MM.yml
+- _data/locales/pt-BR.yml
+- _data/locales/ru-RU.yml
+- _data/locales/sl-SI.yml
+- _data/locales/sv-SE.yml
+- _data/locales/th.yml
+- _data/locales/tr-TR.yml
+- _data/locales/uk-UA.yml
+- _data/locales/vi-VN.yml
+- _data/locales/zh-CN.yml
+- _data/locales/zh-TW.yml
+- _data/origin/basic.yml
+- _data/origin/cors.yml
+- _includes/.DS_Store
+- _includes/analytics/goatcounter.html
+- _includes/analytics/google.html
+- _includes/comments.html
+- _includes/comments/disqus.html
+- _includes/comments/giscus.html
+- _includes/comments/utterances.html
+- _includes/datetime.html
+- _includes/embed/bilibili.html
+- _includes/embed/twitch.html
+- _includes/embed/video.html
+- _includes/embed/youtube.html
+- _includes/favicons.html
+- _includes/footer.html
+- _includes/head.html
+- _includes/img-url.html
+- _includes/js-selector.html
+- _includes/jsdelivr-combine.html
+- _includes/lang.html
+- _includes/language-alias.html
+- _includes/mermaid.html
+- _includes/metadata-hook.html
+- _includes/mode-toggle.html
+- _includes/no-linenos.html
+- _includes/notification.html
+- _includes/origin-type.html
+- _includes/pageviews/goatcounter.html
+- _includes/post-nav.html
+- _includes/post-paginator.html
+- _includes/post-sharing.html
+- _includes/read-time.html
+- _includes/refactor-content.html
+- _includes/related-posts.html
+- _includes/search-loader.html
+- _includes/search-results.html
+- _includes/sidebar.html
+- _includes/toc.html
+- _includes/topbar.html
+- _includes/trending-tags.html
+- _includes/update-list.html
+- _layouts/archives.html
+- _layouts/categories.html
+- _layouts/category.html
+- _layouts/compress.html
+- _layouts/default.html
+- _layouts/home.html
+- _layouts/page.html
+- _layouts/post.html
+- _layouts/tag.html
+- _layouts/tags.html
+- _sass/.DS_Store
+- _sass/addon/commons.scss
+- _sass/addon/module.scss
+- _sass/addon/syntax.scss
+- _sass/addon/variables.scss
+- _sass/colors/syntax-dark.scss
+- _sass/colors/syntax-light.scss
+- _sass/colors/typography-dark.scss
+- _sass/colors/typography-light.scss
+- _sass/layout/archives.scss
+- _sass/layout/categories.scss
+- _sass/layout/category-tag.scss
+- _sass/layout/home.scss
+- _sass/layout/post.scss
+- _sass/layout/tags.scss
+- _sass/main.scss
+- _sass/variables-hook.scss
+- assets/.DS_Store
+- assets/404.html
+- assets/css/doc-theme.scss
+- assets/feed.xml
+- assets/img/favicons/android-chrome-192x192.png
+- assets/img/favicons/android-chrome-512x512.png
+- assets/img/favicons/apple-touch-icon.png
+- assets/img/favicons/browserconfig.xml
+- assets/img/favicons/favicon-16x16.png
+- assets/img/favicons/favicon-32x32.png
+- assets/img/favicons/favicon.ico
+- assets/img/favicons/mstile-150x150.png
+- assets/img/favicons/site.webmanifest
+- assets/js/data/search.json
+- assets/js/data/swconf.js
+- assets/js/pwa/app.js
+- assets/js/pwa/sw.js
+- assets/robots.txt
+homepage: https://github.com/salarce/doc-theme
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/salarce/doc-theme/issues
+  documentation_uri: https://github.com/salarce/doc-theme/#readme
+  homepage_uri: https://username.github.io/doc-theme-demo
+  source_code_uri: https://github.com/salarce/doc-theme
+  wiki_uri: https://github.com/salarce/doc-theme/wiki
+  plugin_type: theme
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A minimal, responsive, and feature-rich Jekyll theme for technical writing.
+test_files: []