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>2020-10-08 10:17:55 +0300
committerthingsym <thingsym@gmail.com>2020-10-08 10:17:55 +0300
commit7149bad3bb1e456f7ba58113759bcdb9ea402024 (patch)
tree7d0fd82cd07d448f555b4fb267a0135a228e22ce
parent944d5fcb7d9146385350a810f6bf74c13181c298 (diff)
docs: edit README
-rw-r--r--README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 12819ca..3b3084d 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +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
* Search Shortcode powered by [Algolia](https://www.algolia.com/)
* Open Graph
* Analytics with Google Analytics, Google Tag Manager
@@ -70,7 +73,7 @@ For an example of `config.toml`, [config.toml](https://github.com/thingsym/hugo-
### Directory layout
```
-tree .
+tree . -I node_modules
.
├── archetypes
@@ -125,6 +128,7 @@ tree .
│   │   └── single.html
│   └── shortcodes
│   ├── button.html
+│   ├── code.html
│   ├── panel.html
│   └── search.html
├── LICENSE.md
@@ -134,6 +138,7 @@ tree .
├── resources
├── src
│   ├── js
+│   │   ├── code.js
│   │   ├── headerlink.js
│   │   ├── jquery.backtothetop
│   │   │   ├── jquery.backtothetop.js
@@ -173,6 +178,15 @@ tree .
└── webpack.config.js
```
+### Third party library
+
+* [jQuery](https://jquery.com/)
+* [jQuery Easing](https://github.com/gdsmith/jquery.easing)
+* [Font Awesome](https://fontawesome.com/)
+* [clipboard.js](https://clipboardjs.com/)
+* [algoliasearch](https://github.com/algolia/algoliasearch-client-javascript)
+* [Day.js](https://github.com/iamkun/dayjs)
+
### Preview site
To preview your site, run Hugo's built-in local server.