jekyll-theme-2038 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b5e740add7ad1f7050b14f5f1bcbff16ec4220d8199a5656e47c7fba7c931a0
+  data.tar.gz: 17fb3368bcf71d32dc95bde3e84d36ffe17b2f636df4dec60619b8d98badab2c
+SHA512:
+  metadata.gz: 1ef85fcf5099fa8640f1e308cd6f90e8784f0f82af43502d26cac642f91e37fa70cdfc1561ac9bcbac4cee43ec0c40052253452be4cd91149f1ce94280712a06
+  data.tar.gz: 39cddc5b487b3f43f98293c80ba8c6a4bbc41c3f9ed49eceab02dde653357342343310c242be1c0b6ba8cb1a8512a12fbc16beee3f34460557f3adb36cf3ca6e

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 物灵
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 物灵
+
+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,53 @@
+<img src="assets/wordmark.svg" align="right" />
+
+# 2038
+
+![Version 0.1.0 with Gem](https://img.shields.io/badge/gem-0.1.0-519dd9.svg)
+
+> Twenty years from now you will be more disappointed by the things that you didn't do than by the ones you did do. So, throw off the bowlines. Sail away from the safe harbour. Catch the trade winds in your sails. Explore. Dream. Discover.  
+> 20 年后，比起已做之事，你将更因未做之事绝望。所以，抛掉缰绳，驶离避风港，乘信风远航吧。去探索，去梦想，去发现。
+>
+> —— Unknown 佚名
+
+2038 is a minimalist Jekyll theme.
+
+## Screenshots
+
+![Light and English Screenshot](assets/screenshot-light.jpg)
+
+![Dark and Chinese Screenshot](assets/screenshot.jpg)
+
+## Features
+
+* JavaScript-free
+* Light/Dark colour theme
+* Multilingual site
+* Two ways of post list: Pagination and time line
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme2038"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-2038
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-2038
+
+## Todo
+
+* Support of UnicodeMath or ASCIIMath
+* Right-to-left and vertical page
+

data/README.old.md

@@ -0,0 +1,52 @@
+# 2038
+
+Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+
+To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+
+TODO: Delete this and the text above, and describe your gem
+
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "2038"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: 2038
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install 2038
+
+## Usage
+
+TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `2038.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,40 @@
+title: Your Awesome Site
+author:
+        name: 物灵
+        email: mat-ling@139.com
+description:
+lang: cmn-Hans
+
+# Show excerpts in timelines and lists.
+# show_excerpts: true 
+
+theme-2038:
+        wordmark: /assets/wordmark.svg
+        from-year: 2038
+        footer-desc: default-slogan
+#        license: Some license
+        social:
+#               github: 0xis-cn 
+#               instagram: mat__ling
+#               telegram: cn_0xis
+        drawer-links:
+#               -
+#                       name: category
+#                       url: /category
+#               -
+#                       name: tag
+#                       url: /tag
+        footer-links:
+#               -
+#                       name: { cmn-Hans: 中文名, default: English name }
+#                       url: https://www.example.com
+#               -
+#                       name: One name for all languages
+#                       url: https://www.example.org
+
+highlighter: rouge
+markdown: kramdown
+kramdown:
+        input: GFM
+        syntax_highlighter: rouge
+

data/_data/theme-2038-i18n.yml

@@ -0,0 +1,28 @@
+cmn-Hans:
+        main-page: 首页
+        toc: 目录
+        license: 除非另有声明，以上内容以LICENSE协议提供。
+        copyright: 版权所有 ©
+        date-format: '%Y 年 %m 月 %e 日'
+        time-format: '%Y 年 %m 月 %e 日 %H:%M:%S'
+        published-at: 创建于 TIME
+        post-length: LENGTH 千字
+        tag: 标签
+        category: 类别
+        rss-subscribe: RSS 订阅
+        default-slogan: 冲动与你同在。
+
+en:
+        main-page: Main page
+        toc: Table of Content
+        license: The content is available under LICENSE license unless otherwise specified.
+        copyright: Copyright ©
+        date-format: '%b %e, %Y'
+        time-format: '%b %e, %Y %H:%M:%S'
+        published-at: Created in TIME
+        post-length: LENGTHk characters
+        tag: Tags
+        category: Categories
+        rss-subscribe: RSS Subscription
+        default-slogan: May the Impulse be with you.
+

data/_includes/custom-head.html

@@ -0,0 +1,2 @@
+<!-- Write your own head here -->
+

data/_includes/drawer.html

@@ -0,0 +1,26 @@
+{%- assign lang = page.lang | default: site.lang | default: 'cmn-Hans' -%}
+{%- assign info-array = site.data.theme-2038-i18n | map: lang -%}
+{%- assign info = info-array[0] -%}
+{%- assign t2038 = site.theme-2038 -%}
+
+<details class="ml-drawer">
+	<summary class="ml-menu-button">≡</summary>
+	<div class="ml-drawer-inside">
+		<ul class="ml-bookmark">
+			<li>
+				<a href="{{ '/' | relative_url }}">
+					{{ info.main-page }}
+				</a>
+			</li>
+			{%- include link-item.html links=t2038.drawer-links -%}
+		</ul>
+		{%- unless page.no-toc -%}
+		<details open>
+			<summary>{{ info.toc }}</summary>
+				{% include toc.html html=content class='ml-toc'
+				submenu_class='ml-toc-sub' item_class='ml-toc-%level%' %}
+		</details>
+		{%- endunless -%}
+	</div>
+</details>
+

data/_includes/footer.html

@@ -0,0 +1,36 @@
+{%- assign lang = page.lang | default: site.lang | default: 'cmn-Hans' -%}
+{%- assign info-array = site.data.theme-2038-i18n | map: lang -%}
+{%- assign info = info-array[0] -%}
+{%- assign t2038 = site.theme-2038 -%}
+
+<footer class="ml-footer">
+	<aside class="ml-footer-main">
+		{%- include social.html -%}
+		{%- if t2038.wordmark -%}
+			<img alt="{{ site.title }}" class="ml-wordmark" src="{{ t2038.wordmark }}" />
+		{%- endif -%}
+		<div class="ml-footer-divider"></div>
+		<ul class="ml-ul-dot-line">
+			{%- include link-item.html links=t2038.footer-links -%}
+		</ul>
+		<div class="ml-clear"></div>
+		{%- if t2038.footer-desc -%}
+			<p class="ml-footer-desc">{%- include pick-language.html text=t2038.footer-desc -%}</p>
+		{%- endif -%}
+		{%- if t2038.from-year -%}
+			<p class="ml-smaller">
+			{%- assign now-year = 'now' | date: '%Y' -%}
+			{{ info.copyright }} 
+			{% if t2038.from-year != now-year -%}{{ t2038.from-year }}—{%- endif -%}{{ now-year }}
+			{% include pick-language.html text=site.author.name %}
+			</p>
+		{%- endif -%}
+		{%- if t2038.license -%}
+			<p class="ml-smaller">
+			{%- capture lname -%}{%- include pick-language.html text=t2038.license -%}{%- endcapture -%}
+				{{ info.license | replace: 'LICENSE', lname }}
+			</p>
+		{%- endif -%}
+	</aside>
+</footer>
+

data/_includes/head.html

@@ -0,0 +1,15 @@
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0">
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/ayaka14732/syyon-vencie@6b08e67/charissil/CharisSIL.css" />
+	<title>
+		{%- if page.title -%}
+			{{ page.title }} | {{ site.title }}
+		{%- else -%}
+			{{ site.title }}
+		{%- endif -%}
+	</title>
+	<link rel="stylesheet" href="{{ '/assets/main.css' | relative_path }}" />
+	{%- include custom-head.html -%}
+</head>
+

data/_includes/link-item.html

@@ -0,0 +1,8 @@
+{%- for item in include.links -%}
+	<li>
+		<a href="{{ item.url }}">
+			{%- include pick-language.html text=item.name -%}
+		</a>
+	</li>
+{%- endfor -%}
+

data/_includes/page-link.html

@@ -0,0 +1,19 @@
+<ul class="ml-page-list">
+{%- assign title = include.title | default: 'NUM' -%}
+{% for i in (include.from .. include.to) %}
+	<li>
+		{% if i == include.current %}
+		<span class="ml-placeholder">{{ i }}</span>
+		{%- elsif include.first-url and i == 1 -%}
+			<a href="{{ include.first-url }}" title="{{ include.first-title | default: '1' }}">
+				{{ i }}
+			</a>
+		{% else %}
+			<a href="{{ include.url }}" title="{{ title | replace: 'NUM', i }}">
+				{{ i }}
+			</a>
+		{% endif %}
+	</li>
+{% endfor %}
+</ul>
+

data/_includes/pick-language.html

@@ -0,0 +1,6 @@
+{%- assign lang = page.lang | default: site.lang | default: 'cmn-Hans' -%}
+{%- assign info = site.data.theme-2038-i18n | map: lang | first -%}
+{%- assign speech = include.text -%}
+{%- assign preset = info | map: speech | first -%}
+{{- speech | map: lang | first | default: preset | default: speech.default | default: speech -}}
+

data/_includes/plain-list.html

@@ -0,0 +1,17 @@
+{%- assign posts = include.posts | reverse -%}
+<ul class="ml-block-list">
+{%- for cur in posts -%}
+{%- if cur.hidden != true -%}
+	<li>
+		<a href="{{ cur.url | relative_url }}" class="ml-block-anchor">
+			<h2>{{ cur.title }}</h2>
+			{%- if site.show_excerpts -%}
+			{{ cur.excerpt }}
+			{%- endif -%}
+			测试文字
+		</a>
+	</li>
+{%- endif -%}
+{%- endfor -%}
+</ul>
+

data/_includes/social.html

@@ -0,0 +1,21 @@
+{%- assign social = site.theme-2038.social -%}
+
+<ul class="ml-social-list">
+  {%- for glb in social.gitlab -%}{%- if glb.username and glb.instance -%}<li><a rel="me" href="https://{{ glb.instance | cgi_escape | escape}}/{{glb.username}}" title="{{ glb.username | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#gitlab' | relative_url }}"></use></svg></a></li>{%- endif -%}{%- endfor -%}
+  {%- if social.dribbble -%}<li><a rel="me" href="https://dribbble.com/{{ social.dribbble | cgi_escape | escape }}" title="{{ social.dribbble | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#dribbble' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.facebook -%}<li><a rel="me" href="https://www.facebook.com/{{ social.facebook | cgi_escape | escape }}" title="{{ social.facebook | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#facebook' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.flickr -%}<li><a rel="me" href="https://www.flickr.com/photos/{{ social.flickr | cgi_escape | escape }}" title="{{ social.flickr | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#flickr' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.github -%}<li><a rel="me" href="https://github.com/{{ social.github | cgi_escape | escape }}" title="{{ social.github | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#github' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.stackoverflow -%}<li><a rel="me" href="https://stackoverflow.com/users/{{ social.stackoverflow | cgi_escape | escape }}" title="{{ social.stackoverflow | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#stackoverflow' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.instagram -%}<li><a rel="me" href="https://www.instagram.com/{{ social.instagram | cgi_escape | escape }}" title="{{ social.instagram | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#instagram' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.linkedin -%}<li><a rel="me" href="https://www.linkedin.com/in/{{ social.linkedin | cgi_escape | escape }}" title="{{ social.linkedin | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#linkedin' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.pinterest -%}<li><a rel="me" href="https://www.pinterest.com/{{ social.pinterest | cgi_escape | escape }}" title="{{ social.pinterest | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#pinterest' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- for mst in social.mastodon -%}{%- if mst.username and mst.instance -%}<li><a rel="me" href="https://{{ mst.instance | cgi_escape | escape}}/@{{mst.username}}" title="{{ mst.username | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#mastodon' | relative_url }}"></use></svg></a></li>{%- endif -%}{%- endfor -%}
+  {%- if social.twitter -%}<li><a rel="me" href="https://twitter.com/{{ social.twitter | cgi_escape | escape }}" title="{{ social.twitter | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#twitter' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.youtube -%}<li><a rel="me" href="https://www.youtube.com/{{ social.youtube | cgi_escape | escape }}" title="{{ social.youtube | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#youtube' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.youtube_channel -%}<li><a rel="me" href="https://www.youtube.com/channel/{{ social.youtube_channel | cgi_escape | escape }}" title="{{ social.youtube_channel_name | escape | default: 'YouTube' }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#youtube' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.telegram -%}<li><a rel="me" href="https://t.me/{{ social.telegram | cgi_escape | escape }}" title="{{ social.telegram | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#telegram' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.keybase -%}<li><a rel="me" href="https://keybase.io/{{ social.keybase | cgi_escape | escape }}" title="{{ social.keybase | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#keybase' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.microdotblog -%}<li><a rel="me" href="https://micro.blog/{{ social.microdotblog | cgi_escape | escape }}" title="{{ social.microdotblog | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#microdotblog' | relative_url }}"></use></svg></a></li>{%- endif -%}
+  {%- if social.devto -%}<li><a href="https://dev.to/{{ social.devto | cgi_escape | escape }}" title="{{ social.devto | escape }}"><svg viewBox="0 0 16 16" class="svg-icon"><use xlink:href="{{ '/assets/minima-social-icons.svg#devto' | relative_url }}"></use></svg></a></li>{%- endif -%}
+</ul>

data/_includes/time-line.html

@@ -0,0 +1,38 @@
+{%- assign last = 'first' -%}
+{%- assign posts = include.posts | reverse -%}
+{%- for cur in posts -%}
+{%- assign trigger = cur.date | date: include.first -%}
+{%- if trigger == include.range and cur.hidden != true -%}
+{%- assign now = cur.date | date: include.second -%}
+{%- if now != last -%}
+{%- if last == 'first' -%}
+<dl class="ml-card-list">
+{%- else -%}
+		</ul>
+	</dd>
+{%- endif -%}
+{%- assign last = now -%}
+	<dt>{{ last }}</dt>
+	<dd>
+		<ul>
+{%- endif -%}
+			<li>
+				<a href="{{ cur.url | relative_url }}" class="ml-card-anchor">
+					{%- if cur.image -%}
+					<img src="{{ cur.image | relative_url }}" />
+					{%- endif -%}
+					<div class="ml-card-text">
+						<h2>{{ cur.title }}</h2>
+						{%- if site.show_excerpts -%}
+						{{ cur.excerpt }}
+						{%- endif -%}
+					</div>
+				</a>
+			</li>
+{%- endif -%}
+{%- endfor -%}
+		</ul>
+	</dd>
+</dl>
+
+

data/_includes/toc.html

@@ -0,0 +1,182 @@
+{% 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.1.0
+          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
+            * base_url      (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
+            * skip_no_ids   (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 newline %}
+    {% endcapture %}
+    {% assign newline = newline | rstrip %} <!-- Remove the extra spacing but preserve the newline -->
+
+    {% capture deprecation_warnings %}{% endcapture %}
+
+    {% if include.baseurl %}
+        {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "baseurl" has been deprecated, use "base_url" instead -->{{ newline }}{% endcapture %}
+    {% endif %}
+
+    {% if include.skipNoIDs %}
+        {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "skipNoIDs" has been deprecated, use "skip_no_ids" instead -->{{ newline }}{% endcapture %}
+    {% endif %}
+
+    {% capture jekyll_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign baseURL = include.base_url | default: include.baseurl | default: '' %}
+    {% assign skipNoIDs = include.skip_no_ids | default: include.skipNoIDs | default: false %}
+    {% assign minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | strip | split: '<h' %}
+
+    {% assign firstHeader = true %}
+    {% assign currLevel = 0 %}
+    {% assign lastLevel = 0 %}
+
+    {% capture listModifier %}{% if orderedList %}ol{% else %}ul{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign currLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if currLevel < minHeader or currLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign htmlID = _idWorkspace[0] %}
+
+        {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
+        {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
+        {% assign htmlClass = _classWorkspace[0] %}
+
+        {% if htmlClass contains "no_toc" %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign minHeader = currLevel %}
+        {% endif %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% if include.item_class and include.item_class != blank %}
+            {% capture listItemClass %} class="{{ include.item_class | replace: '%level%', currLevel | split: '.' | join: ' ' }}"{% endcapture %}
+        {% endif %}
+
+        {% if include.submenu_class and include.submenu_class != blank %}
+            {% assign subMenuLevel = currLevel | minus: 1 %}
+            {% capture subMenuClass %} class="{{ include.submenu_class | replace: '%level%', subMenuLevel | split: '.' | join: ' ' }}"{% endcapture %}
+        {% endif %}
+
+        {% capture anchorBody %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
+
+        {% if htmlID %}
+            {% capture anchorAttributes %} href="{% if baseURL %}{{ baseURL }}{% endif %}#{{ htmlID }}"{% endcapture %}
+
+            {% if include.anchor_class %}
+                {% capture anchorAttributes %}{{ anchorAttributes }} class="{{ include.anchor_class | split: '.' | join: ' ' }}"{% endcapture %}
+            {% endif %}
+
+            {% capture listItem %}<a{{ anchorAttributes }}>{{ anchorBody }}</a>{% endcapture %}
+        {% elsif skipNoIDs == true %}
+            {% continue %}
+        {% else %}
+            {% capture listItem %}{{ anchorBody }}{% endcapture %}
+        {% endif %}
+
+        {% if currLevel > lastLevel %}
+            {% capture jekyll_toc %}{{ jekyll_toc }}<{{ listModifier }}{{ subMenuClass }}>{% endcapture %}
+        {% elsif currLevel < lastLevel %}
+            {% assign repeatCount = lastLevel | minus: currLevel %}
+
+            {% for i in (1..repeatCount) %}
+                {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %}
+            {% endfor %}
+
+            {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %}
+        {% else %}
+            {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %}
+        {% endif %}
+
+        {% capture jekyll_toc %}{{ jekyll_toc }}<li{{ listItemClass }}>{{ listItem }}{% endcapture %}
+
+        {% assign lastLevel = currLevel %}
+        {% assign firstHeader = false %}
+    {% endfor %}
+
+    {% assign repeatCount = minHeader | minus: 1 %}
+    {% assign repeatCount = lastLevel | minus: repeatCount %}
+    {% for i in (1..repeatCount) %}
+        {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %}
+    {% endfor %}
+
+    {% if jekyll_toc != '' %}
+        {% assign rootAttributes = '' %}
+        {% if include.class and include.class != blank %}
+            {% capture rootAttributes %} class="{{ include.class | split: '.' | join: ' ' }}"{% endcapture %}
+        {% endif %}
+
+        {% if include.id and include.id != blank %}
+            {% capture rootAttributes %}{{ rootAttributes }} id="{{ include.id }}"{% endcapture %}
+        {% endif %}
+
+        {% if rootAttributes %}
+            {% assign nodes = jekyll_toc | split: '>' %}
+            {% capture jekyll_toc %}<{{ listModifier }}{{ rootAttributes }}>{{ nodes | shift | join: '>' }}>{% endcapture %}
+        {% endif %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ deprecation_warnings }}{{ jekyll_toc }}