Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/thingsym/hugo-theme-techdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorthingsym <thingsym@gmail.com>2021-03-08 14:55:00 +0300
committerthingsym <thingsym@gmail.com>2021-03-08 14:55:00 +0300
commit0677e27e76f1e217129b1f6404744ab6c192724a (patch)
treeb611f68ea8435624e3a3315e41f7c545f48be11d
parent889dc8bb8dffee6dd4f00200ad1dd7c95e7ab8c4 (diff)
parent929c63171297df55f7330b4e5d9e7796faf706a3 (diff)
Merge branch 'release-0.9.7' into develop
-rw-r--r--README.md172
-rwxr-xr-xexampleSite/config.toml2
-rw-r--r--exampleSite/content/getting-started/configuration.md4
-rw-r--r--package-lock.json2
-rw-r--r--package.json2
-rw-r--r--static/js/bundle.js2
6 files changed, 96 insertions, 88 deletions
diff --git a/README.md b/README.md
index bf8c8e5..8b2be4c 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,9 @@ The Techdoc is a Hugo Theme for technical documentation.
* Edit link to documentation repository
* Header link to HTML headings
* Custom Shortcodes
- * Code highlight with clipboard
- * Alert panel
- * Button
+ * Code highlight with clipboard
+ * Alert panel
+ * Button
* Search Shortcode powered by [Algolia](https://www.algolia.com/)
* Open Graph
* Analytics with Google Analytics, Google Tag Manager
@@ -93,8 +93,11 @@ git commit
tree . -I node_modules
.
+├── LICENSE.md
+├── README.md
├── archetypes
│   └── default.md
+├── docker-compose.yml
├── exampleSite
│   └── ..
├── gulpfile.js
@@ -143,15 +146,13 @@ tree . -I node_modules
│   ├── posts
│   │   ├── list.html
│   │   └── single.html
-│   └── shortcodes
+│   ├── shortcodes
│   ├── button.html
│   ├── code.html
│   ├── panel.html
│   └── search.html
-├── LICENSE.md
-├── package.json
├── package-lock.json
-├── README.md
+├── package.json
├── resources
├── src
│   ├── js
@@ -164,24 +165,24 @@ tree . -I node_modules
│   │   ├── main.js
│   │   └── sidebar-menu.js
│   └── scss
-│   ├── chroma.scss
│   ├── _component.scss
+│   ├── _project.scss
+│   ├── _structure.scss
+│   ├── _variable.scss
+│   ├── chroma.scss
│   ├── foundation
│   │   ├── _element.scss
+│   │   ├── _index.scss
│   │   ├── _normalize.scss
│   │   ├── _reset.scss
│   │   └── _stack.scss
-│   ├── _foundation.scss
│   ├── function
│   │   ├── _calc-font-size.scss
│   │   ├── _calc-stack.scss
│   │   ├── _contrast-color.scss
+│   │   ├── _index.scss
│   │   └── _strip-unit.scss
-│   ├── _function.scss
-│   ├── _project.scss
-│   ├── _structure.scss
-│   ├── theme.scss
-│   └── _variable.scss
+│   └── theme.scss
├── static
│   ├── css
│   │   ├── chroma.css
@@ -265,94 +266,101 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
## Changelog
+* Version 0.9.7 - 2021.03.08
+ * add docker-compose.yml for development environment
+ * change keyboard event from event.keyCode to event.key because it is deprecated
+ * update package.json
+ * add FUNDING.yml
+ * fix space for minify publish
+ * change flexbox-grid-mixins from libsass to dart-sass
* Version 0.9.6 - 2020.11.22
- * add sample Markdown Syntax
- * update sample document
- * replace scss from node-sass to dart-sass
+ * add sample Markdown Syntax
+ * update sample document
+ * replace scss from node-sass to dart-sass
* Version 0.9.5 - 2020.11.05
- * fix link style with Alert panel
+ * fix link style with Alert panel
* Version 0.9.4 - 2020.10.08
- * improve scss for custom shortcodes using css custom properties
- * change stack to css custom properties
- * fix scss
- * fix button shortcode, adding notice color
- * add Code highlight with clipboard custom shortcode
- * fix webpack.config.js
- * fix npm scripts
- * update package.json
- * adjust no sidebar layout
+ * improve scss for custom shortcodes using css custom properties
+ * change stack to css custom properties
+ * fix scss
+ * fix button shortcode, adding notice color
+ * add Code highlight with clipboard custom shortcode
+ * fix webpack.config.js
+ * fix npm scripts
+ * update package.json
+ * adjust no sidebar layout
* Version 0.9.3 - 2020.08.02
- * remove jQuery dependency with keydown nav
- * add header link
+ * remove jQuery dependency with keydown nav
+ * add header link
* Version 0.9.2 - 2020.06.14
- * add note and sample to document
- * fix tableOfContents endLevel
- * add chapter 'unlimited levels' to document
- * add menu indentation up to 5 levels
+ * add note and sample to document
+ * fix tableOfContents endLevel
+ * add chapter 'unlimited levels' to document
+ * add menu indentation up to 5 levels
* Version 0.9.1 - 2020.05.24
- * fix config.toml
- * fix url in rss meta link
- * remove line break in algolia.json
+ * fix config.toml
+ * fix url in rss meta link
+ * remove line break in algolia.json
* Version 0.9.0 - 2020.04.01
- * fix lint config
- * update Sample Document
- * update jQuery to v3.4.1
- * add search function and shortcode powered by Algolia
- * fix config.toml
- * fix sass
- * fix hugo deprecated warning
+ * fix lint config
+ * update Sample Document
+ * update jQuery to v3.4.1
+ * add search function and shortcode powered by Algolia
+ * fix config.toml
+ * fix sass
+ * fix hugo deprecated warning
* Version 0.8.3 - 2020.03.19
- * fix edit page link
+ * fix edit page link
* Version 0.8.2 - 2020.03.07
- * fix open graph image path
+ * fix open graph image path
* Version 0.8.1 - 2020.03.07
- * fix open graph image path
+ * fix open graph image path
* Version 0.8.0 - 2020.02.27
- * update Sample Document
- * config.toml
- * add open graph image to exampleSite
- * add safeCSS for ZgotmplZ with generated by Hugo Template
+ * update Sample Document
+ * config.toml
+ * add open graph image to exampleSite
+ * add safeCSS for ZgotmplZ with generated by Hugo Template
* Version 0.7.0 - 2020.02.07
- * bump up Hugo minimum version to 0.60.0
- * change shortcode delimiter from % to <
- * improve tableOfContents for Goldmark
+ * bump up Hugo minimum version to 0.60.0
+ * change shortcode delimiter from % to <
+ * improve tableOfContents for Goldmark
* Version 0.6.0 - 2020.01.13
- * fix scss
- * gulp bump up version to 4.0
- * fix hugo deprecated warning
+ * fix scss
+ * gulp bump up version to 4.0
+ * fix hugo deprecated warning
* Version 0.5.0 - 2019.12.08
- * update Sample Document
- * add table of contents
- * add open graph
- * add function and stack scss
+ * update Sample Document
+ * add table of contents
+ * add open graph
+ * add function and stack scss
* Version 0.4.0 - 2019.11.02
- * update Sample Document
- * add Theme color
- * add Menu style
- * improve scss
+ * update Sample Document
+ * add Theme color
+ * add Menu style
+ * improve scss
* Version 0.3.0 - 2019.10.06
- * fix archetypes
- * add prepend-body.html for Tag Manager noscript version
- * change class name from menu to global-menu
- * rename partials files
- * fix javascript path for webpack
- * improve development environment
- * move javascript files to src directory
+ * fix archetypes
+ * add prepend-body.html for Tag Manager noscript version
+ * change class name from menu to global-menu
+ * rename partials files
+ * fix javascript path for webpack
+ * improve development environment
+ * move javascript files to src directory
* Version 0.2.2 - 2019.04.27
- * fix Lastmod's and PublishDate's initial value of 0001-01-01
+ * fix Lastmod's and PublishDate's initial value of 0001-01-01
* Version 0.2.1 - 2018.12.07
- * fix scss lint errors
- * change lint from scss-lint to stylelint
- * add published date
- * change the font color of powered by
- * fix link on powered by
+ * fix scss lint errors
+ * change lint from scss-lint to stylelint
+ * add published date
+ * change the font color of powered by
+ * fix link on powered by
* Version 0.2.0 - 2018.11.21
- * add screenshot images
- * add exampleSite
- * fix sub-menu for responsive
- * improve menu and pagination
+ * add screenshot images
+ * add exampleSite
+ * fix sub-menu for responsive
+ * improve menu and pagination
* Version 0.1.0 - 2018.03.04
- * initial release
+ * initial release
## License
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index f385da7..f029af0 100755
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -17,7 +17,7 @@ enableMissingTranslationPlaceholders = false
# Source Code repository section
description = "put your description"
github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
- version = "0.9.6"
+ version = "0.9.7"
# Documentation repository section
# documentation repository (set edit link to documentation repository)
diff --git a/exampleSite/content/getting-started/configuration.md b/exampleSite/content/getting-started/configuration.md
index 72818ac..b786d3b 100644
--- a/exampleSite/content/getting-started/configuration.md
+++ b/exampleSite/content/getting-started/configuration.md
@@ -15,7 +15,7 @@ For an example of `config.toml`, see [config.toml](https://github.com/thingsym/h
# Source Code repository section
description = "put your description"
github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
- version = "0.9.6"
+ version = "0.9.7"
# Documentation repository section
# documentation repository (set edit link to documentation repository)
@@ -80,7 +80,7 @@ default: `https://github.com/thingsym/hugo-theme-techdoc`
The version of souce code
-default: `0.9.6`
+default: `0.9.7`
#### `github_doc_repository`
diff --git a/package-lock.json b/package-lock.json
index 8161c2e..2a315f4 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "hugo-theme-techdoc",
- "version": "0.9.6",
+ "version": "0.9.7",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/package.json b/package.json
index 887cb91..e7d70de 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "hugo-theme-techdoc",
- "version": "0.9.6",
+ "version": "0.9.7",
"description": "The Techdoc is a Hugo Theme for technical documentation.",
"main": "gulpfile.js",
"author": "Thingsym",
diff --git a/static/js/bundle.js b/static/js/bundle.js
index 336d2bf..aa5da37 100644
--- a/static/js/bundle.js
+++ b/static/js/bundle.js
@@ -1 +1 @@
-!function(t){var e={};function o(n){if(e[n])return e[n].exports;var a=e[n]={i:n,l:!1,exports:{}};return t[n].call(a.exports,a,a.exports,o),a.l=!0,a.exports}o.m=t,o.c=e,o.d=function(t,e,n){o.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},o.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},o.t=function(t,e){if(1&e&&(t=o(t)),8&e)return t;if(4&e&&"object"==typeof t&&t&&t.__esModule)return t;var n=Object.create(null);if(o.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:t}),2&e&&"string"!=typeof t)for(var a in t)o.d(n,a,function(e){return t[e]}.bind(null,a));return n},o.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return o.d(e,"a",e),e},o.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},o.p="",o(o.s=0)}([function(t,e,o){o(1),o(2),o(3),o(4),o(5)},function(t,e){var o;(o=jQuery)(document).ready((function(){o(".has-sub-menu > a span.mark").on("click",(function(t){o(this).parent().siblings("ul").slideToggle("fast","swing",(function(){var t="";t=o(this).is(":visible")?"-":"+",o(this).siblings("a").children("span.mark").text(t)})),t.preventDefault()}))}))},function(t,e){document.addEventListener("DOMContentLoaded",(function(){var t=document.querySelector(".nav-prev"),e=document.querySelector(".nav-next");document.addEventListener("keydown",(function(o){t&&37===o.keyCode&&(location.href=t.getAttribute("href")),e&&39===o.keyCode&&(location.href=e.getAttribute("href"))}))}))},function(t,e){var o;(o=jQuery)(window).on("load.BackToTheTop",(function(){o('a[href^="#"]').BackToTheTop()})),o.fn.BackToTheTop=function(t){var e={duration:300,easing:"swing",offset:0,hash:!0,scrolloffset:0,fadein:"slow",fadeout:"slow",display:"bottom-right",top:0,bottom:0,left:0,right:0,zIndex:999,position:"fixed"};o.extend(e,t),o('a[href^="#"]').on("click.BackToTheTop",(function(){var t=void 0!==o(this).data("backtothetop-scrolltop")?o(this).data("backtothetop-scrolltop"):o(this.hash).offset()?o(this.hash).offset().top:"backtothetop-fixed"==o(this).attr("id")&&"#"==o(this).attr("href")?0:null;if(null!==t){var n=void 0===o(this).data("backtothetop-duration")?e.duration:o(this).data("backtothetop-duration"),a=void 0===o(this).data("backtothetop-easing")?e.easing:o(this).data("backtothetop-easing"),i=void 0===o(this).data("backtothetop-offset")?e.offset:o(this).data("backtothetop-offset"),r=void 0===o(this).data("backtothetop-hash")?e.hash:o(this).data("backtothetop-hash"),d=o(this).attr("href");return o("html,body").animate({scrollTop:t+i},n,a,(function(){!0===r&&window.history.pushState("","",d)})),!1}})),function(){var t=o("a#backtothetop-fixed");if(t){var n=void 0===t.data("backtothetop-fixed-scroll-offset")?e.scrolloffset:t.data("backtothetop-fixed-scroll-offset"),a=void 0===t.data("backtothetop-fixed-fadein")?e.fadein:t.data("backtothetop-fixed-fadein"),i=void 0===t.data("backtothetop-fixed-fadeout")?e.fadeout:t.data("backtothetop-fixed-fadeout"),r=void 0===t.data("backtothetop-fixed-display")?e.display:t.data("backtothetop-fixed-display"),d=void 0===t.data("backtothetop-fixed-top")?e.top:t.data("backtothetop-fixed-top"),c=void 0===t.data("backtothetop-fixed-bottom")?e.bottom:t.data("backtothetop-fixed-bottom"),f=void 0===t.data("backtothetop-fixed-left")?e.left:t.data("backtothetop-fixed-left"),s=void 0===t.data("backtothetop-fixed-right")?e.right:t.data("backtothetop-fixed-right"),u=void 0===t.data("backtothetop-fixed-zindex")?e.zIndex:t.data("backtothetop-fixed-zindex");"top-left"==r?(c="none",s="none"):"top-right"==r?(c="none",f="none"):"bottom-left"==r?(d="none",s="none"):"bottom-right"==r&&(d="none",f="none"),t.css({display:"none"}),o(window).on("scroll.BackToTheTop",(function(){o(this).scrollTop()>n?(t.css({top:d,bottom:c,left:f,right:s,zIndex:u,position:e.position}),"none"==t.css("display")&&t.fadeIn(a)):o(this).scrollTop()<=0+n&&"none"!=t.css("display")&&t.fadeOut(i)}))}}()}},function(t,e){document.addEventListener("DOMContentLoaded",(function(){document.querySelector("main").querySelectorAll("h1, h2, h3, h4, h5, h6").forEach((function(t){if(t.id){var e=document.createElement("a");e.setAttribute("class","headerlink"),e.setAttribute("href","#"+t.id),e.setAttribute("title","Permalink to this headline");var o=document.createElement("i");o.setAttribute("class","fas fa-hashtag"),o.setAttribute("aria-hidden","true"),e.append(o),t.append(e)}}))}))},function(t,e){!function(){function t(t){t.currentTarget.setAttribute("class","copy-btn copy"),t.currentTarget.setAttribute("aria-label","Copy this code.")}window.onload=function(){new ClipboardJS(".copy",{target:function(t){return t.nextElementSibling}}).on("success",(function(t){!function(t,e){t.setAttribute("class","copy-btn copy tooltipped"),t.setAttribute("aria-label",e)}(t.trigger,"Copied!"),t.clearSelection()})).on("error",(function(t){console.error("Action:",t.action),console.error("Trigger:",t.trigger)}))},document.addEventListener("DOMContentLoaded",(function(){document.querySelectorAll(".copy").forEach((function(e){e.addEventListener("animationend",t)}))}))}()}]); \ No newline at end of file
+!function(){var t={262:function(){!function(){function t(t){t.currentTarget.setAttribute("class","copy-btn copy"),t.currentTarget.setAttribute("aria-label","Copy this code.")}window.onload=function(){new ClipboardJS(".copy",{target:function(t){return t.nextElementSibling}}).on("success",(function(t){!function(t,o){t.setAttribute("class","copy-btn copy tooltipped"),t.setAttribute("aria-label","Copied!")}(t.trigger),t.clearSelection()})).on("error",(function(t){console.error("Action:",t.action),console.error("Trigger:",t.trigger)}))},document.addEventListener("DOMContentLoaded",(function(){document.querySelectorAll(".copy").forEach((function(o){o.addEventListener("animationend",t)}))}))}()},169:function(){document.addEventListener("DOMContentLoaded",(function(){document.querySelector("main").querySelectorAll("h1, h2, h3, h4, h5, h6").forEach((function(t){if(t.id){var o=document.createElement("a");o.setAttribute("class","headerlink"),o.setAttribute("href","#"+t.id),o.setAttribute("title","Permalink to this headline");var e=document.createElement("i");e.setAttribute("class","fas fa-hashtag"),e.setAttribute("aria-hidden","true"),o.append(e),t.append(o)}}))}))},337:function(){var t;(t=jQuery)(window).on("load.BackToTheTop",(function(){t('a[href^="#"]').BackToTheTop()})),t.fn.BackToTheTop=function(o){var e={duration:300,easing:"swing",offset:0,hash:!0,scrolloffset:0,fadein:"slow",fadeout:"slow",display:"bottom-right",top:0,bottom:0,left:0,right:0,zIndex:999,position:"fixed"};t.extend(e,o),t('a[href^="#"]').on("click.BackToTheTop",(function(){var o=void 0!==t(this).data("backtothetop-scrolltop")?t(this).data("backtothetop-scrolltop"):t(this.hash).offset()?t(this.hash).offset().top:"backtothetop-fixed"==t(this).attr("id")&&"#"==t(this).attr("href")?0:null;if(null!==o){var a=void 0===t(this).data("backtothetop-duration")?e.duration:t(this).data("backtothetop-duration"),i=void 0===t(this).data("backtothetop-easing")?e.easing:t(this).data("backtothetop-easing"),n=void 0===t(this).data("backtothetop-offset")?e.offset:t(this).data("backtothetop-offset"),d=void 0===t(this).data("backtothetop-hash")?e.hash:t(this).data("backtothetop-hash"),r=t(this).attr("href");return t("html,body").animate({scrollTop:o+n},a,i,(function(){!0===d&&window.history.pushState("","",r)})),!1}})),function(){var o=t("a#backtothetop-fixed");if(o){var a=void 0===o.data("backtothetop-fixed-scroll-offset")?e.scrolloffset:o.data("backtothetop-fixed-scroll-offset"),i=void 0===o.data("backtothetop-fixed-fadein")?e.fadein:o.data("backtothetop-fixed-fadein"),n=void 0===o.data("backtothetop-fixed-fadeout")?e.fadeout:o.data("backtothetop-fixed-fadeout"),d=void 0===o.data("backtothetop-fixed-display")?e.display:o.data("backtothetop-fixed-display"),r=void 0===o.data("backtothetop-fixed-top")?e.top:o.data("backtothetop-fixed-top"),c=void 0===o.data("backtothetop-fixed-bottom")?e.bottom:o.data("backtothetop-fixed-bottom"),s=void 0===o.data("backtothetop-fixed-left")?e.left:o.data("backtothetop-fixed-left"),f=void 0===o.data("backtothetop-fixed-right")?e.right:o.data("backtothetop-fixed-right"),h=void 0===o.data("backtothetop-fixed-zindex")?e.zIndex:o.data("backtothetop-fixed-zindex");"top-left"==d?(c="none",f="none"):"top-right"==d?(c="none",s="none"):"bottom-left"==d?(r="none",f="none"):"bottom-right"==d&&(r="none",s="none"),o.css({display:"none"}),t(window).on("scroll.BackToTheTop",(function(){t(this).scrollTop()>a?(o.css({top:r,bottom:c,left:s,right:f,zIndex:h,position:e.position}),"none"==o.css("display")&&o.fadeIn(i)):t(this).scrollTop()<=0+a&&"none"!=o.css("display")&&o.fadeOut(n)}))}}()}},670:function(){document.addEventListener("DOMContentLoaded",(function(){var t=document.querySelector(".nav-prev"),o=document.querySelector(".nav-next");document.addEventListener("keydown",(function(e){t&&"ArrowLeft"===e.key&&(location.href=t.getAttribute("href")),o&&"ArrowRight"===e.key&&(location.href=o.getAttribute("href"))}))}))},598:function(){var t;(t=jQuery)(document).ready((function(){t(".has-sub-menu > a span.mark").on("click",(function(o){t(this).parent().siblings("ul").slideToggle("fast","swing",(function(){var o;o=t(this).is(":visible")?"-":"+",t(this).siblings("a").children("span.mark").text(o)})),o.preventDefault()}))}))}},o={};function e(a){if(o[a])return o[a].exports;var i=o[a]={exports:{}};return t[a](i,i.exports,e),i.exports}e(598),e(670),e(337),e(169),e(262)}(); \ No newline at end of file