diff options
author | thingsym <thingsym@gmail.com> | 2021-03-08 14:48:01 +0300 |
---|---|---|
committer | thingsym <thingsym@gmail.com> | 2021-03-08 14:48:01 +0300 |
commit | 8d790e2da1372ddacfc32aef9c7df9c0d017176e (patch) | |
tree | f36440c41627f96249942b8a9d8e72e8d7173078 | |
parent | 889dc8bb8dffee6dd4f00200ad1dd7c95e7ab8c4 (diff) |
docs: fix README
-rw-r--r-- | README.md | 165 |
1 files changed, 83 insertions, 82 deletions
@@ -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 @@ -266,93 +267,93 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin ## Changelog * 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 |