diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2a1ec73f95..e3243e2ef2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -40,7 +40,7 @@ jobs: LAST_TAG=$(git describe --tags --abbrev=0) git log ${LAST_TAG}..HEAD --no-merges --format="- %h %s @%an" > action.changelog.md sed -i "s/${LAST_TAG:1}/${VERSION}/g" jekyll-rtd-theme.gemspec - sed -i "s/${LAST_TAG:1}/${VERSION}/g" _includes/reset/version.liquid + sed -i "s/${LAST_TAG:1}/${VERSION}/g" _includes/rest/variables.liquid - name: Prettier check and Build theme assets! run: | diff --git a/Gemfile b/Gemfile index 842e3536b9..8a923ff1c1 100644 --- a/Gemfile +++ b/Gemfile @@ -1,5 +1,4 @@ -source "https://gems.ruby-china.com" -# source "https://rubygems.org" +source "https://rubygems.org" # source "https://gems.ruby-china.com" gemspec diff --git a/README.md b/README.md index 6e376ea807..0639a1e17e 100644 --- a/README.md +++ b/README.md @@ -66,13 +66,9 @@ mermaid: custom: # mermaid link initialize: # mermaid options, default: {} -# also available via file: _include/assets/custom.scss scss: - -# also available via file: _include/assets/custom.js script: -# also available via file: _data/translate.yml translate: # shortcodes danger: diff --git a/_config.yml b/_config.yml index 26b44ae7e9..63a934a721 100644 --- a/_config.yml +++ b/_config.yml @@ -3,10 +3,10 @@ description: Opinionated standard documentation theme, with few options, but eve theme: null -# debug: -# compress: true -# dist: false -# shortcodes: true +debug: + compress: true + dist: false + shortcodes: true readme_index: with_frontmatter: true @@ -19,9 +19,10 @@ plugins: exclude: - Makefile - CNAME + - LICENSE + - update.sh - Gemfile - Gemfile.lock - - LICENSE - requirements.txt - node_modules - package.json diff --git a/_includes/README.md b/_includes/README.md new file mode 100644 index 0000000000..42d4fec0a2 --- /dev/null +++ b/_includes/README.md @@ -0,0 +1,9 @@ +# Document Statement + +## templates + +Template files for this theme + +## common + +Some common variables and code snippets are designed to be shared by multiple themes diff --git a/_includes/addons/github.liquid b/_includes/addons/github.liquid deleted file mode 100644 index 560c0a7ebb..0000000000 --- a/_includes/addons/github.liquid +++ /dev/null @@ -1,21 +0,0 @@ -
' -%}
+ {%- if site.mermaid.custom -%}
+
+ {%- else -%}
+
+ {%- endif %}
+
+{%- endif %}
diff --git a/_includes/common/meta.liquid b/_includes/common/meta.liquid
new file mode 100644
index 0000000000..0bbd71e46e
--- /dev/null
+++ b/_includes/common/meta.liquid
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+{%- for meta in site.meta -%}
+
+{%- endfor -%}
+
+
diff --git a/_includes/common/opengraph.liquid b/_includes/common/opengraph.liquid
new file mode 100644
index 0000000000..9e5966d5ce
--- /dev/null
+++ b/_includes/common/opengraph.liquid
@@ -0,0 +1,8 @@
+
+
+
+
+
+
+
+
diff --git a/_includes/reset/content.liquid b/_includes/common/rest/content.liquid
similarity index 100%
rename from _includes/reset/content.liquid
rename to _includes/common/rest/content.liquid
diff --git a/_includes/reset/description.liquid b/_includes/common/rest/description.liquid
similarity index 100%
rename from _includes/reset/description.liquid
rename to _includes/common/rest/description.liquid
diff --git a/_includes/reset/i18n.liquid b/_includes/common/rest/i18n.liquid
similarity index 100%
rename from _includes/reset/i18n.liquid
rename to _includes/common/rest/i18n.liquid
diff --git a/_includes/reset/navigation.liquid b/_includes/common/rest/nav.liquid
similarity index 90%
rename from _includes/reset/navigation.liquid
rename to _includes/common/rest/nav.liquid
index 8c3cc385a4..b8d2ed2440 100644
--- a/_includes/reset/navigation.liquid
+++ b/_includes/common/rest/nav.liquid
@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid workdir=page.dir -%}
+{%- include common/rest/workdir.liquid workdir=page.dir -%}
{% comment %} prev and next {% endcomment %}
{%- assign index = 0 -%}
diff --git a/_includes/reset/site_pages.liquid b/_includes/common/rest/site_pages.liquid
similarity index 100%
rename from _includes/reset/site_pages.liquid
rename to _includes/common/rest/site_pages.liquid
diff --git a/_includes/reset/tabs.liquid b/_includes/common/rest/tabs.liquid
similarity index 100%
rename from _includes/reset/tabs.liquid
rename to _includes/common/rest/tabs.liquid
diff --git a/_includes/reset/title.liquid b/_includes/common/rest/title.liquid
similarity index 100%
rename from _includes/reset/title.liquid
rename to _includes/common/rest/title.liquid
diff --git a/_includes/reset/variables.liquid b/_includes/common/rest/variables.liquid
similarity index 69%
rename from _includes/reset/variables.liquid
rename to _includes/common/rest/variables.liquid
index 210a37fa5a..59214dff0c 100644
--- a/_includes/reset/variables.liquid
+++ b/_includes/common/rest/variables.liquid
@@ -1,31 +1,32 @@
{%- comment %} variables {% endcomment -%}
+{%- assign version = theme_alias | split: "@" | last -%}
{%- assign docs = site.github -%}
{%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
{%- assign rest_created_at = rest.created_at | default: site.time -%}
{%- assign rest_updated_at = rest.updated_at | default: site.time -%}
+{%- comment %} defaults {% endcomment -%}
{%- assign direction = site.direction | default: "auto" -%}
{%- assign lang = site.lang | default: "en" -%}
{%- assign author = docs.owner.name | default: docs.owner_name -%}
+{%- capture generator -%}
+ {%- if site.remote_theme -%}
+ {{- theme_alias | split: "@" | first -}}
+ {%- else -%}
+ {{- theme_alias | split: "@" | first | split: "/" | last -}}
+ {%- endif -%}
+{%- endcapture -%}
+
{%- comment %} schema {% endcomment -%}
{%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
{%- assign schema_modi = site.time | date_to_xmlschema -%}
{%- assign schema_surl = page.url | absolute_url | xml_escape -%}
-{% comment %} custom {% endcomment %}
-{%- capture custom_scss -%}
- {%- include assets/custom.scss -%} {{- site.scss -}}
-{%- endcapture -%}
-
-{%- capture custom_script -%}
- {%- include assets/custom.js -%} {{- site.script -}}
-{%- endcapture -%}
-
{% comment %} debug {% endcomment %}
{%- if site.debug -%}
{%- assign base = site.baseurl -%}
{%- else -%}
- {%- assign base = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+ {%- assign base = "https://cdn.jsdelivr.net/gh/" | append: theme_alias -%}
{%- endif -%}
diff --git a/_includes/reset/workdir.liquid b/_includes/common/rest/workdir.liquid
similarity index 100%
rename from _includes/reset/workdir.liquid
rename to _includes/common/rest/workdir.liquid
diff --git a/_includes/node/script.schema.liquid b/_includes/common/schema.liquid
similarity index 100%
rename from _includes/node/script.schema.liquid
rename to _includes/common/schema.liquid
diff --git a/_includes/node/script.liquid b/_includes/common/script.liquid
similarity index 68%
rename from _includes/node/script.liquid
rename to _includes/common/script.liquid
index 249b3c008a..c9f2ba98d5 100644
--- a/_includes/node/script.liquid
+++ b/_includes/common/script.liquid
@@ -9,10 +9,3 @@
}
};
-
-
-{%- if custom_script.size > 0 -%}
-
-{%- endif -%}
-
-
diff --git a/_includes/node/title.liquid b/_includes/common/title.liquid
similarity index 100%
rename from _includes/node/title.liquid
rename to _includes/common/title.liquid
diff --git a/_includes/common/twitter_cards.liquid b/_includes/common/twitter_cards.liquid
new file mode 100644
index 0000000000..8981142984
--- /dev/null
+++ b/_includes/common/twitter_cards.liquid
@@ -0,0 +1,6 @@
+
+
+
+
+
+
diff --git a/_includes/extend/list.liquid b/_includes/extend/list.liquid
deleted file mode 100644
index 013dcfdd3c..0000000000
--- a/_includes/extend/list.liquid
+++ /dev/null
@@ -1,15 +0,0 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/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 reset/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
-
-{%- for item in workdir_files %}
-{% include reset/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
-{%- endfor -%}
-
-{%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
diff --git a/_includes/extra/footer.html b/_includes/extra/footer.html
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/_includes/extra/head.html b/_includes/extra/head.html
deleted file mode 100644
index e69de29bb2..0000000000
diff --git a/_includes/list.liquid b/_includes/list.liquid
index b8c7318cdd..1a0be6f27b 100644
--- a/_includes/list.liquid
+++ b/_includes/list.liquid
@@ -1,10 +1 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/workdir.liquid workdir=page.dir -%}
-
-{%- for item in workdir_files %}
-- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
-{%- endfor -%}
-
-{%- if include.all -%}
- {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
-{%- endif -%}
+{%- include common/core/list.liquid -%}
diff --git a/_includes/node/metadata.liquid b/_includes/node/metadata.liquid
deleted file mode 100644
index 540e9a2175..0000000000
--- a/_includes/node/metadata.liquid
+++ /dev/null
@@ -1,31 +0,0 @@
-
-
-
-
-
-
-
-
-
-{%- comment %} custom {% endcomment %}
-{% for meta in site.meta -%}
-
-{% endfor -%}
-
-{% comment %} Open Graph {% endcomment %}
-
-
-
-
-
-
-
-
-
-{% comment %} Twitter Card {% endcomment %}
-
-
-
-
-
-
diff --git a/_includes/node/script.extension.liquid b/_includes/node/script.extension.liquid
deleted file mode 100644
index a5d5792c2a..0000000000
--- a/_includes/node/script.extension.liquid
+++ /dev/null
@@ -1,29 +0,0 @@
-{%- comment %} mermaid {% endcomment -%}
-{%- if content contains '' -%}
- {%- if site.mermaid.custom -%}
-
- {%- else -%}
-
- {%- endif %}
-
-{%- endif %}
-
-{% comment %} Google Analytics {% endcomment %}
-{%- if site.google.gtag -%}
-
-
-{%- endif -%}
-
-{% comment %} Google AdSense {% endcomment %}
-{%- if site.google.adsense -%}
-
-{%- endif -%}
diff --git a/_includes/reset/defaults.liquid b/_includes/reset/defaults.liquid
deleted file mode 100644
index 5951d63dc7..0000000000
--- a/_includes/reset/defaults.liquid
+++ /dev/null
@@ -1,11 +0,0 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/i18n.liquid -%}
-{%- include reset/version.liquid -%}
-
-{%- include reset/variables.liquid -%}
-
-{%- include reset/content.liquid -%}
-
-{%- include reset/navigation.liquid -%}
-{%- include reset/title.liquid -%}
-{%- include reset/description.liquid -%}
diff --git a/_includes/reset/version.liquid b/_includes/reset/version.liquid
deleted file mode 100644
index b15b4c91cc..0000000000
--- a/_includes/reset/version.liquid
+++ /dev/null
@@ -1 +0,0 @@
-{%- assign version = "2.0.9" -%}
diff --git a/_includes/rest/script.liquid b/_includes/rest/script.liquid
new file mode 100644
index 0000000000..820a24e9f8
--- /dev/null
+++ b/_includes/rest/script.liquid
@@ -0,0 +1,7 @@
+
+
+{%- if site.script.size > 0 -%}
+
+{%- endif -%}
+
+
diff --git a/_includes/rest/styles.liquid b/_includes/rest/styles.liquid
new file mode 100644
index 0000000000..128e9e7a7c
--- /dev/null
+++ b/_includes/rest/styles.liquid
@@ -0,0 +1,6 @@
+{% comment %} theme {% endcomment %}
+
+
+{%- if site.scss.size > 0 -%}
+
+{%- endif -%}
diff --git a/_includes/rest/variables.liquid b/_includes/rest/variables.liquid
new file mode 100644
index 0000000000..7f6f93c1c7
--- /dev/null
+++ b/_includes/rest/variables.liquid
@@ -0,0 +1,2 @@
+{%- assign theme_alias = "rundocs/jekyll-rtd-theme@2.0.9" -%}
+{%- assign theme_color = "#2980b9" -%}
diff --git a/_includes/extend/toctree.liquid b/_includes/templates/_toctree.liquid
similarity index 92%
rename from _includes/extend/toctree.liquid
rename to _includes/templates/_toctree.liquid
index 14691fb586..e3fc8dc2c8 100644
--- a/_includes/extend/toctree.liquid
+++ b/_includes/templates/_toctree.liquid
@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid %}
+{%- include common/rest/workdir.liquid %}
{% comment %} display the directory name {% endcomment %}
{%- assign dir = site_pages | where: "url", workdir | first -%}
@@ -36,6 +36,6 @@
{% comment %} list dirs {% endcomment %}
{%- for workdir in workdir_dirs -%}
{%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
- {% include extend/toctree.liquid %}
+ {% include templates/_toctree.liquid %}
{%- endfor -%}
diff --git a/_includes/templates/addons.liquid b/_includes/templates/addons.liquid
new file mode 100644
index 0000000000..84b179be4c
--- /dev/null
+++ b/_includes/templates/addons.liquid
@@ -0,0 +1,43 @@
+
+
+
+ {{ site.title }}
+
+
+
+ {{ docs.source.branch }}
+
+
+
+
+
+
+ - {{ __.github | default: "GitHub" }}
+ -
+
+
+ {{ __.homepage | default: "Homepage" }}
+
+
+ -
+
+
+ {{ __.issues | default: "Issues" }}
+
+
+ -
+
+
+ {{ __.download | default: "Download" }}
+
+
+
+
+
+ This
+ Software
+ is under the terms of
+ {{ docs.license.name | default: "The Unlicense" }}.
+
+
+
diff --git a/_includes/class/_breadcrumbs.liquid b/_includes/templates/breadcrumbs.liquid
similarity index 100%
rename from _includes/class/_breadcrumbs.liquid
rename to _includes/templates/breadcrumbs.liquid
diff --git a/_includes/class/content-wrap.liquid b/_includes/templates/content.liquid
similarity index 88%
rename from _includes/class/content-wrap.liquid
rename to _includes/templates/content.liquid
index 0a02058f9e..87c568bf8a 100644
--- a/_includes/class/content-wrap.liquid
+++ b/_includes/templates/content.liquid
@@ -8,13 +8,13 @@
- {% include class/_breadcrumbs.liquid %}
+ {% include templates/breadcrumbs.liquid %}
{{ content }}
- {% include class/_footer.liquid %}
+ {% include templates/footer.liquid %}
diff --git a/_includes/class/_footer.liquid b/_includes/templates/footer.liquid
similarity index 90%
rename from _includes/class/_footer.liquid
rename to _includes/templates/footer.liquid
index 9e032b73c9..d0f8afd8b1 100644
--- a/_includes/class/_footer.liquid
+++ b/_includes/templates/footer.liquid
@@ -44,9 +44,9 @@
diff --git a/_includes/class/sidebar-wrap.liquid b/_includes/templates/sidebar.liquid
similarity index 94%
rename from _includes/class/sidebar-wrap.liquid
rename to _includes/templates/sidebar.liquid
index 37bd33d610..14688015ca 100644
--- a/_includes/class/sidebar-wrap.liquid
+++ b/_includes/templates/sidebar.liquid
@@ -12,7 +12,7 @@
diff --git a/_includes/class/_toctree.liquid b/_includes/templates/toctree.liquid
similarity index 87%
rename from _includes/class/_toctree.liquid
rename to _includes/templates/toctree.liquid
index 52a80c75b1..48513a2520 100644
--- a/_includes/class/_toctree.liquid
+++ b/_includes/templates/toctree.liquid
@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid %}
+{%- include common/rest/workdir.liquid %}
{% comment %} list the root files {% endcomment %}
@@ -20,4 +20,4 @@
{% comment %} list the root dirs {% endcomment %}
-{%- for workdir in workdir_dirs %}{% include extend/toctree.liquid %}{% endfor -%}
+{%- for workdir in workdir_dirs %}{% include templates/_toctree.liquid %}{% endfor -%}
diff --git a/_layouts/default.liquid b/_layouts/default.liquid
index 5aa39c51fa..e5d9658e99 100644
--- a/_layouts/default.liquid
+++ b/_layouts/default.liquid
@@ -2,27 +2,35 @@
layout: tasks/compress
---
-{%- include reset/defaults.liquid -%}
+{%- include rest/variables.liquid -%}
+
+{%- include common/rest/site_pages.liquid -%}
+{%- include common/rest/i18n.liquid -%}
+{%- include common/rest/variables.liquid -%}
+{%- include common/rest/content.liquid -%}
+{%- include common/rest/nav.liquid -%}
+{%- include common/rest/title.liquid -%}
+{%- include common/rest/description.liquid -%}
- {%- include node/metadata.liquid -%}
-
- {%- include node/title.liquid -%}
- {%- include node/links.liquid -%}
- {%- include node/script.schema.liquid -%}
-
- {%- include extra/head.html -%}
+ {%- include common/meta.liquid -%}
+ {%- include common/title.liquid -%}
+ {%- include common/twitter_cards.liquid -%}
+ {%- include common/opengraph.liquid -%}
+ {%- include common/schema.liquid -%}
+ {%- include common/links.liquid -%}
+ {%- include rest/styles.liquid -%}
+ {%- include common/script.liquid -%}
- {%- include class/sidebar-wrap.liquid -%}
- {%- include class/content-wrap.liquid -%}
- {%- include class/addons-wrap.liquid -%}
-
- {%- include node/script.liquid -%}
- {%- include node/script.extension.liquid -%}
-
- {%- include extra/footer.html -%}
+ {%- include templates/sidebar.liquid -%}
+ {%- include templates/content.liquid -%}
+ {%- include templates/addons.liquid -%}
+ {%- include rest/script.liquid -%}
+ {%- include common/mermaid.liquid-%}
+ {%- include common/google_gtag.liquid-%}
+ {%- include common/google_adsense.liquid-%}
diff --git a/_layouts/tasks/shortcodes.liquid b/_layouts/tasks/shortcodes.liquid
index bcd455e683..4a0197d7e4 100644
--- a/_layouts/tasks/shortcodes.liquid
+++ b/_layouts/tasks/shortcodes.liquid
@@ -1,4 +1,4 @@
-{%- include reset/i18n.liquid -%}
+{%- include common/rest/i18n.liquid -%}
{%- assign shortcodes = "mermaid, warning, note, tip, danger" | split: ", " -%}
diff --git a/_sass/class/addons-wrap.scss b/_sass/core/addons.scss
similarity index 100%
rename from _sass/class/addons-wrap.scss
rename to _sass/core/addons.scss
diff --git a/_sass/class/container.scss b/_sass/core/container.scss
similarity index 100%
rename from _sass/class/container.scss
rename to _sass/core/container.scss
diff --git a/_sass/class/content-wrap.scss b/_sass/core/content.scss
similarity index 100%
rename from _sass/class/content-wrap.scss
rename to _sass/core/content.scss
diff --git a/_sass/class/header.scss b/_sass/core/header.scss
similarity index 100%
rename from _sass/class/header.scss
rename to _sass/core/header.scss
diff --git a/_sass/class/markdown-body.scss b/_sass/core/markdown.scss
similarity index 100%
rename from _sass/class/markdown-body.scss
rename to _sass/core/markdown.scss
diff --git a/_sass/class/sidebar-wrap.scss b/_sass/core/sidebar.scss
similarity index 100%
rename from _sass/class/sidebar-wrap.scss
rename to _sass/core/sidebar.scss
diff --git a/_sass/class/title.scss b/_sass/core/title.scss
similarity index 100%
rename from _sass/class/title.scss
rename to _sass/core/title.scss
diff --git a/_sass/class/toasts.scss b/_sass/core/toasts.scss
similarity index 100%
rename from _sass/class/toasts.scss
rename to _sass/core/toasts.scss
diff --git a/_sass/theme.scss b/_sass/theme.scss
index d5905e7d13..6a623e5832 100644
--- a/_sass/theme.scss
+++ b/_sass/theme.scss
@@ -21,14 +21,14 @@
// theme
@import "layout";
@import "reset";
-@import "class/container";
-@import "class/sidebar-wrap";
-@import "class/addons-wrap";
-@import "class/content-wrap";
-@import "class/header";
-@import "class/title";
-@import "class/markdown-body";
-@import "class/toasts";
+@import "core/container";
+@import "core/sidebar";
+@import "core/addons";
+@import "core/content";
+@import "core/header";
+@import "core/title";
+@import "core/markdown";
+@import "core/toasts";
// improved
@import "direction";
diff --git a/assets/404.liquid b/assets/404.liquid
index 3f2c7ef618..d6ba0f4e7f 100644
--- a/assets/404.liquid
+++ b/assets/404.liquid
@@ -3,7 +3,7 @@ layout: default
permalink: /404.html
---
-{%- include reset/i18n.liquid -%}
+{%- include common/rest/i18n.liquid -%}
404
{{ __.not_found | default: "Not Found"}}
diff --git a/assets/data.liquid b/assets/data.liquid
new file mode 100644
index 0000000000..4ff4e34fcf
--- /dev/null
+++ b/assets/data.liquid
@@ -0,0 +1,6 @@
+---
+layout: tasks/compress
+permalink: /data.json
+---
+
+{%- include common/assets/data.liquid -%}
diff --git a/assets/images/favicon.svg b/assets/images/favicon.liquid
similarity index 52%
rename from assets/images/favicon.svg
rename to assets/images/favicon.liquid
index 2b9d78a253..47e78270c8 100644
--- a/assets/images/favicon.svg
+++ b/assets/images/favicon.liquid
@@ -1,5 +1,13 @@
-
-