Merge branch 'release-1.0.1'

thingsym · Aug 20, 2024 · 56dca59 · 56dca59
2 parents efa9d44 + cb3e0f8
commit 56dca59
Show file tree

Hide file tree

Showing 10 changed files with 6,107 additions and 5,456 deletions.
diff --git a/.github/demo_hugo.toml b/.github/demo_hugo.toml
@@ -17,11 +17,12 @@ enableMissingTranslationPlaceholders = false
     # Source Code repository section
     description = "put your description"
     github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    version = "1.0.0"
+    version = "1.0.1"
 
     # Documentation repository section
     # documentation repository (set edit link to documentation repository)
     github_doc_repository = "https://github.com/thingsym/hugo-theme-techdoc"
+    github_doc_repository_branch = "master"
     github_doc_repository_path = "exampleSite/content/"
 
     # Analytic section
@@ -74,11 +75,18 @@ enableMissingTranslationPlaceholders = false
         name = "Home"
         url = "/"
         weight = 1
+        identifier = 'home'
+        pre = "<i class='fa fa-heart'></i>&nbsp;"
 
     [[menu.main]]
         name = "Twitter"
         url = "https://twitter.com/thingsym"
         weight = 2
+        identifier = 'twitter'
+        pre = "<b>pre!</b> "
+        post = " <b>post!</b>"
+        [menu.main.params]
+          class = 'twitter-menu-item'
 
 # Markup configure section
 # See https://gohugo.io/getting-started/configuration-markup/

diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ The Techdoc is a Hugo Theme for technical documentation.
 
 ### Requirement
 
-Hugo minimum version: 0.60.0
+Hugo minimum version: 0.120.0
 
 Default Markdown parser library `Goldmark` compatible
 
@@ -113,7 +113,7 @@ tree . -I node_modules
 ├── README.md
 ├── archetypes
 │   └── default.md
-├── docker-compose.yml
+├── compose.yml
 ├── exampleSite
 │   └── ..
 ├── gulpfile.js
@@ -254,7 +254,7 @@ npm run gulp watch
 
 ```
 cd /path/to/hugo-theme-techdoc
-docker-compose up -d
+docker compose up -d
 ```
 
 Browse site on http://localhost:1313
@@ -263,8 +263,8 @@ Browse site on http://localhost:1313
 
 ```
 cd /path/to/hugo-theme-techdoc
-docker-compose run --rm node npm install
-docker-compose run --rm node npm run watch
+docker compose run --rm node npm install
+docker compose run --rm node npm run watch
 ```
 
 ## Contribution
@@ -281,7 +281,19 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
 
 ## Changelog
 
-* Version 1.0.0 - 2022.08.21
+* Version 1.0.1 - 2024.08.20
+	* fix README
+	* fix exampleSite document
+	* fix sass
+	* update npm dependencies
+	* fix hugo config
+	* rename docker-compose.yml to compose.yml
+	* change hugo docker image
+	* fix deprecation warning [#68]
+	* bring example site up to date [#66]
+	* fix typos [#65]
+	* fix github workflows
+* Version 1.0.0 - 2023.08.21
 	* update hugo docker image
 	* update npm dependencies
 	* allow to set branch of github documentation repository [#64]

diff --git a/docker-compose.yml → compose.yml b/docker-compose.yml → compose.yml
@@ -1,13 +1,12 @@
-version: '3'
 services:
   hugo:
-    image: klakegg/hugo:0.101.0-alpine
+    image: hugomods/hugo:go-0.121.2
     volumes:
       - .:/hugo/themes/hugo-theme-techdoc
     ports:
       - 1313:1313
     working_dir: /hugo/themes/hugo-theme-techdoc/exampleSite
-    command: "server --bind 0.0.0.0 -wD --ignoreCache --themesDir ../.. --minify"
+    command: "hugo server --bind 0.0.0.0 -wD --ignoreCache --themesDir ../.. --minify --panicOnWarning"
 
   node:
     image: node:lts

diff --git a/exampleSite/content/getting-started/configuration.md b/exampleSite/content/getting-started/configuration.md
@@ -15,13 +15,13 @@ For an example of `hugo.toml`, see [hugo.toml](https://github.com/thingsym/hugo-
     # Source Code repository section
     description = "put your description"
     github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    version = "1.0.0"
+    version = "1.0.1"
 
     # Documentation repository section
     # documentation repository (set edit link to documentation repository)
     github_doc_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    github_doc_repository_path = ""
     github_doc_repository_branch = "master"
+    github_doc_repository_path = ""
 
     # Analytic section
     google_analytics_id = "" # Your Google Analytics tracking id
@@ -82,7 +82,7 @@ default: `https://github.com/thingsym/hugo-theme-techdoc`
 
 The version of source code
 
-default: `1.0.0`
+default: `1.0.1`
 
 #### `github_doc_repository`
 

diff --git a/exampleSite/hugo.toml b/exampleSite/hugo.toml
@@ -17,13 +17,13 @@ enableMissingTranslationPlaceholders = false
     # Source Code repository section
     description = "put your description"
     github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    version = "1.0.0"
+    version = "1.0.1"
 
     # Documentation repository section
     # documentation repository (set edit link to documentation repository)
     github_doc_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    github_doc_repository_path = ""
     github_doc_repository_branch = "master"
+    github_doc_repository_path = ""
 
     # Analytic section
     google_analytics_id = "" # Your Google Analytics tracking id