Merge branch 'release-1.0.0'

thingsym · Aug 21, 2023 · 0dc6473 · 0dc6473
2 parents b56dda0 + 3afc0a7
commit 0dc6473
Show file tree

Hide file tree

Showing 8 changed files with 10,168 additions and 10,513 deletions.
diff --git a/.github/demo_config.toml b/.github/demo_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.9"
+    version = "1.0.0"
 
     # Documentation repository section
     # documentation repository (set edit link to documentation repository)

diff --git a/README.md b/README.md
@@ -281,6 +281,11 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
 
 ## Changelog
 
+* Version 1.0.0 - 2022.08.21
+	* update hugo docker image
+	* update npm dependencies
+	* allow to set branch of github documentation repository [#64]
+	* enable use as a Hugo module [#63]
 * Version 0.9.9 - 2022.07.08
 	* fix scss
 	* bump up version on jquery, jquery.easing and clipboard
@@ -293,15 +298,13 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
 	* use SRI for CDN js sources [#45]
 	* fix heading styles
 	* change to using math.div for division
-
 * Version 0.9.8 - 2021.10.18
 	* fix sample document
 	* edit README
 	* update package.json
 	* add github_doc_repository_path
 	* change to relative link
 	* add workflows for publishing demo site to gh-pages
-
 * 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

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,7 +1,7 @@
 version: '3'
 services:
   hugo:
-    image: klakegg/hugo:0.81.0-alpine
+    image: klakegg/hugo:0.101.0-alpine
     volumes:
       - .:/hugo/themes/hugo-theme-techdoc
     ports:

diff --git a/exampleSite/config.toml b/exampleSite/config.toml
@@ -17,12 +17,13 @@ enableMissingTranslationPlaceholders = false
     # Source Code repository section
     description = "put your description"
     github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-    version = "0.9.9"
+    version = "1.0.0"
 
     # 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"
 
     # Analytic section
     google_analytics_id = "" # Your Google Analytics tracking id

diff --git a/exampleSite/content/getting-started/configuration.md b/exampleSite/content/getting-started/configuration.md
@@ -12,59 +12,59 @@ For an example of `config.toml`, see [config.toml](https://github.com/thingsym/h
 
 ## Params
 
-		# Source Code repository section
-		description = "put your description"
-		github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
-		version = "0.9.9"
-
-		# 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"
-
-		# Analytic section
-		google_analytics_id = "" # Your Google Analytics tracking id
-		tag_manager_container_id = "" # Your Google Tag Manager container id
-		google_site_verification = "" # Your Google Site Verification for Search Console
-
-		# Open Graph and Twitter Cards settings section
-		# Open Graph settings for each page are set on the front matter.
-		# See https://gohugo.io/templates/internal/#open-graph
-		# See https://gohugo.io/templates/internal/#twitter-cards
-		title = "Hugo Techdoc Theme"
-		images = ["images/og-image.png"] # Open graph images are placed in `static/images`
-
-		# Theme settings section
-		# Theme color
-		# See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
-		custom_font_color = ""
-		custom_background_color = ""
-
-		# Documentation Menu section
-		# Menu style settings
-		menu_style = "open-menu" # "open-menu" or "slide-menu" or "" blank is as no sidebar
-
-		# Date format
-		dateformat = "" # default "2 Jan 2006"
-		# See the format reference https://gohugo.io/functions/format/#hugo-date-and-time-templating-reference
-
-		# path name excluded from documentation menu
-		menu_exclusion = [
-				"archives",
-				"archive",
-				"blog",
-				"entry",
-				"post",
-				"posts",
-		]
-
-		# Algolia site search section
-		# See https://www.algolia.com/doc/
-		algolia_search_enable = true
-		algolia_indexName = "hugo-demo-techdoc"
-		algolia_appId = "7W4SAN4PLK"
-		algolia_apiKey = "cbf12a63ff72d9c5dc0c10c195cf9128" # Search-Only API Key
+    # Source Code repository section
+    description = "put your description"
+    github_repository = "https://github.com/thingsym/hugo-theme-techdoc"
+    version = "1.0.0"
+
+    # 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"
+
+    # Analytic section
+    google_analytics_id = "" # Your Google Analytics tracking id
+    tag_manager_container_id = "" # Your Google Tag Manager container id
+    google_site_verification = "" # Your Google Site Verification for Search Console
+
+    # Open Graph and Twitter Cards settings section
+    # Open Graph settings for each page are set on the front matter.
+    # See https://gohugo.io/templates/internal/#open-graph
+    # See https://gohugo.io/templates/internal/#twitter-cards
+    title = "Hugo Techdoc Theme"
+    images = ["images/og-image.png"] # Open graph images are placed in `static/images`
+
+    # Theme settings section
+    # Theme color
+    # See color value reference https://developer.mozilla.org/en-US/docs/Web/CSS/color
+    custom_font_color = ""
+    custom_background_color = ""
+
+    # Documentation Menu section
+    # Menu style settings
+    menu_style = "open-menu" # "open-menu" or "slide-menu" or "" blank is as no sidebar
+
+    # Date format
+    dateformat = "" # default "2 Jan 2006"
+    # See the format reference https://gohugo.io/functions/format/#hugo-date-and-time-templating-reference
+
+    # path name excluded from documentation menu
+    menu_exclusion = [
+        "archives",
+        "archive",
+        "blog",
+        "entry",
+        "post",
+        "posts",
+    ]
+
+    # Algolia site search section
+    # See https://www.algolia.com/doc/
+    algolia_search_enable = true
+    algolia_indexName = "hugo-demo-techdoc"
+    algolia_appId = "7W4SAN4PLK"
+    algolia_apiKey = "cbf12a63ff72d9c5dc0c10c195cf9128" # Search-Only API Key
 
 #### `description`
 
@@ -82,7 +82,7 @@ default: `https://github.com/thingsym/hugo-theme-techdoc`
 
 The version of souce code
 
-default: `0.9.9`
+default: `1.0.0`
 
 #### `github_doc_repository`
 
@@ -167,13 +167,13 @@ Path name excluded from documentation menu
 By default, we exclude commonly used folder names in blogs.
 
 default: `[
-				"archives",
-				"archive",
-				"blog",
-				"entry",
-				"post",
-				"posts"
-		]`
+			"archives",
+			"archive",
+			"blog",
+			"entry",
+			"post",
+			"posts"
+	]`
 
 
 #### `algolia_search_enable`

diff --git a/layouts/partials/edit-page.html b/layouts/partials/edit-page.html
@@ -1,3 +1,3 @@
 {{- if and .Site.Params.github_doc_repository .File -}}
-<a href="{{ .Site.Params.github_doc_repository }}/edit/{{ .Site.Params.github_doc_repository_branch | default 'master' }}/{{ .Site.Params.github_doc_repository_path }}{{ .File.Path }}" class="edit-page"><i class="fas fa-pen-square"></i>&nbsp;Edit on GitHub</a>
+<a href="{{ .Site.Params.github_doc_repository }}/edit/{{ .Site.Params.github_doc_repository_branch | default "master" }}/{{ .Site.Params.github_doc_repository_path }}{{ .File.Path }}" class="edit-page"><i class="fas fa-pen-square"></i>&nbsp;Edit on GitHub</a>
 {{- end -}}