Merge branch 'release-0.9.5'

thingsym · Nov 5, 2020 · 00460ce · 00460ce
2 parents 31ee73a + 49f1ffb
commit 00460ce
Show file tree

Hide file tree

Showing 11 changed files with 78 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -53,16 +53,25 @@ Hugo minimum version: 0.60.0
 
 Default Markdown parser library `Goldmark` compatible
 
-### Download Hugo theme
+### Install Hugo theme on your project
 
-If you have git installed, you can do the following at the command-line-interface within the Hugo directory:
+If you have git installed, you can include hugo-theme-techdoc repository into your core repository as submodule using `git submodule` within your project directory.
 
 ```
-cd themes
-git clone https://github.com/thingsym/hugo-theme-techdoc.git
+cd your_project
+git submodule add https://github.com/thingsym/hugo-theme-techdoc.git themes/hugo-theme-techdoc
 ```
 
-For more information read [the Hugo documentation](https://gohugo.io/themes/installing-and-using-themes/).
+For more information read [the Hugo documentation](https://gohugo.io/getting-started/quick-start/).
+
+### Or download Hugo theme on your project
+
+If you have git installed, you can do the following at the command-line-interface within your project directory.
+
+```
+cd your_project/themes
+git clone https://github.com/thingsym/hugo-theme-techdoc.git
+```
 
 ### Configure
 
@@ -226,6 +235,9 @@ Small patches and bug reports can be submitted a issue tracker in Github. Forkin
 
 ## Changelog
 
+* Version 0.9.5 - 2020.11.05
+  * 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

diff --git 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.4"
+    version = "0.9.5"
 
     # 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
@@ -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.4"
+    version = "0.9.5"
 
     # 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.4`
+default: `0.9.5`
 
 #### `github_doc_repository`
 

diff --git a/exampleSite/content/getting-started/installation.md b/exampleSite/content/getting-started/installation.md
@@ -5,16 +5,25 @@ draft: false
 weight: 10
 ---
 
-## Download Hugo theme
+## Install Hugo theme on your project
 
-If you have git installed, you can do the following at the command-line-interface within the Hugo directory:
+If you have git installed, you can include hugo-theme-techdoc repository into your core repository as submodule using `git submodule` within your project directory.
 
 ```
-cd themes
-git clone https://github.com/thingsym/hugo-theme-techdoc.git
+cd your_project
+git submodule add https://github.com/thingsym/hugo-theme-techdoc.git themes/hugo-theme-techdoc
 ```
 
-For more information read [the Hugo documentation](https://gohugo.io/themes/installing-and-using-themes/).
+For more information read [the Hugo documentation](https://gohugo.io/getting-started/quick-start/).
+
+## Or download Hugo theme on your project
+
+If you have git installed, you can do the following at the command-line-interface within your project directory.
+
+```
+cd your_project/themes
+git clone https://github.com/thingsym/hugo-theme-techdoc.git
+```
 
 ## Configure
 

diff --git a/exampleSite/content/sample/_index.md b/exampleSite/content/sample/_index.md
@@ -17,7 +17,7 @@ description: "this is a sample document."
 
 ## Paragraph
 
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. [Ut enim ad minim veniam](https://github.com/thingsym/hugo-theme-techdoc), quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
 ## Emphasis
 

diff --git a/exampleSite/content/sample/custom-shortcodes.md b/exampleSite/content/sample/custom-shortcodes.md
@@ -28,9 +28,9 @@ TableOfContents: true
 ### Alert panel using HTML
 
 {{< panel >}}
-<strong>Lorem ipsum dolor sit amet</strong>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim venia</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+<strong>Lorem ipsum dolor sit amet</strong>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-<strong>Lorem ipsum dolor sit amet</strong>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim venia</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+<strong>Lorem ipsum dolor sit amet</strong>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 {{< /panel >}}
 
 ### Alert panel using Markdown (use the `%` character)
@@ -45,21 +45,21 @@ TableOfContents: true
 
 ### Alert panel with titles and colors
 
-{{< panel title="primary" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel title="primary" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
-{{< panel status="notice" title="notice" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="notice" title="notice" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
-{{< panel status="success" title="success" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="success" title="success" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
-{{< panel status="caution" title="caution" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="caution" title="caution" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
-{{< panel status="warning" title="warning" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="warning" title="warning" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
-{{< panel status="danger" title="danger" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="danger" title="danger" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
 ### Alert panel with Font Awesome
 
-{{< panel status="danger" title="danger" icon="fas fa-exclamation-triangle" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
+{{< panel status="danger" title="danger" icon="fas fa-exclamation-triangle" >}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim veniam</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{< /panel >}}
 
 ## Button
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "hugo-theme-techdoc",
-  "version": "0.9.4",
+  "version": "0.9.5",
   "description": "The Techdoc is a Hugo Theme for technical documentation.",
   "main": "gulpfile.js",
   "author": "Thingsym",

diff --git a/src/scss/_component.scss b/src/scss/_component.scss
@@ -72,6 +72,11 @@ figure > figcaption {
 	background: var(--panel-background-color, unset);
 	border: 1px solid;
 	border-color: var(--panel-border-color, transparent);
+
+	a {
+		text-decoration: underline;
+		font-weight: bold;
+	}
 }
 
 .panel-primary {
@@ -80,22 +85,33 @@ figure > figcaption {
 .panel-notice {
 	--panel-font-color: #fff;
 	--panel-background-color: #4ba0e1;
+	--custom-link-text-color: #fff;
+	--custom-link-text-hover-color: #fff;
+
 }
 .panel-success {
 	--panel-font-color: #fff;
 	--panel-background-color: #609f43;
+	--custom-link-text-color: #fff;
+	--custom-link-text-hover-color: #fff;
 }
 .panel-caution {
 	--panel-font-color: #fff;
 	--panel-background-color: #de776d;
+	--custom-link-text-color: #fff;
+	--custom-link-text-hover-color: #fff;
 }
 .panel-warning {
 	--panel-font-color: #fff;
 	--panel-background-color: #e67e22;
+	--custom-link-text-color: #fff;
+	--custom-link-text-hover-color: #fff;
 }
 .panel-danger {
 	--panel-font-color: #fff;
 	--panel-background-color: #ce3426;
+	--custom-link-text-color: #fff;
+	--custom-link-text-hover-color: #fff;
 }
 
 .panel-header {}

diff --git a/static/css/theme.css b/static/css/theme.css
@@ -862,33 +862,48 @@ main:only-child {
   border-color: var(--panel-border-color, transparent);
 }
 
+.panel a {
+  text-decoration: underline;
+  font-weight: bold;
+}
+
 .panel-primary {
   --panel-border-color: #f0f0f0;
 }
 
 .panel-notice {
   --panel-font-color: #fff;
   --panel-background-color: #4ba0e1;
+  --custom-link-text-color: #fff;
+  --custom-link-text-hover-color: #fff;
 }
 
 .panel-success {
   --panel-font-color: #fff;
   --panel-background-color: #609f43;
+  --custom-link-text-color: #fff;
+  --custom-link-text-hover-color: #fff;
 }
 
 .panel-caution {
   --panel-font-color: #fff;
   --panel-background-color: #de776d;
+  --custom-link-text-color: #fff;
+  --custom-link-text-hover-color: #fff;
 }
 
 .panel-warning {
   --panel-font-color: #fff;
   --panel-background-color: #e67e22;
+  --custom-link-text-color: #fff;
+  --custom-link-text-hover-color: #fff;
 }
 
 .panel-danger {
   --panel-font-color: #fff;
   --panel-background-color: #ce3426;
+  --custom-link-text-color: #fff;
+  --custom-link-text-hover-color: #fff;
 }
 
 .button {