Merge branch 'release-0.9.6'

thingsym · Nov 22, 2020 · a84ed5b · a84ed5b
2 parents 00460ce + 76b39a9
commit a84ed5b
Show file tree

Hide file tree

Showing 25 changed files with 509 additions and 296 deletions.
diff --git a/README.md b/README.md
@@ -79,6 +79,14 @@ You may specify options in config.toml (or config.yaml/config.json) of your site
 
 For an example of `config.toml`, [config.toml](https://github.com/thingsym/hugo-theme-techdoc/blob/master/exampleSite/config.toml) in exampleSite.
 
+### Update Hugo theme for git submodule
+
+```
+git submodule update --remote
+git add themes/hugo-theme-techdoc
+git commit
+```
+
 ### Directory layout
 
 ```
@@ -235,9 +243,12 @@ 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
 * 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.5"
+    version = "0.9.6"
 
     # 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.5"
+    version = "0.9.6"
 
     # 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.5`
+default: `0.9.6`
 
 #### `github_doc_repository`
 

diff --git a/exampleSite/content/sample/_index.md b/exampleSite/content/sample/_index.md
@@ -6,14 +6,14 @@ weight: 10
 description: "this is a sample document."
 ---
 
-## Header
+## Headings
 
-# H1 Header
-## H2 Header
-### H3 Header
-#### H4 Header
-##### H5 Header
-###### H6 Header
+# Heading level 1
+## Heading level 2
+### Heading level 3
+#### Heading level 4
+##### Heading level 5
+###### Heading level 6
 
 ## Paragraph
 
@@ -27,7 +27,9 @@ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
 
 ---
 
-## List
+## Lists
+
+### Unordered Lists
 
 * Lorem ipsum dolor sit amet, consectetur adipisicing elit
 * Lorem ipsum dolor sit amet, consectetur adipisicing elit
@@ -37,23 +39,30 @@ Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
 	* Lorem ipsum dolor sit amet, consectetur adipisicing elit
 	* Lorem ipsum dolor sit amet, consectetur adipisicing elit
 
+### Ordered Lists
+
 1. Lorem ipsum dolor sit amet, consectetur adipisicing elit
 2. Lorem ipsum dolor sit amet, consectetur adipisicing elit
 3. Lorem ipsum dolor sit amet, consectetur adipisicing elit
 
 ## Code
 
 ```ruby
-puts 'The best way to log and share programmers knowledge.' puts 'The best way to log and share programmers knowledge.'
+puts 'The best way to log and share programmers knowledge.' 
+puts 'The best way to log and share programmers knowledge.'
 
-puts 'The best way to log and share programmers knowledge.' puts 'The best way to log and share programmers knowledge.'
+puts 'The best way to log and share programmers knowledge.' 
+puts 'The best way to log and share programmers knowledge.'
 
 puts 'The best way to log and share programmers knowledge.'
 
+puts 'The best way to log and share programmers knowledge.' 
+puts 'The best way to log and share programmers knowledge.' 
 puts 'The best way to log and share programmers knowledge.'
-puts 'The best way to log and share programmers knowledge.' puts 'The best way to log and share programmers knowledge.'
 ```
 
+## Inline code
+
 inline code `#ffce44`
 
 ## Blockquote
@@ -91,6 +100,30 @@ inline code `#ffce44`
 
 ![2 People Sitting With View of Yellow Flowers during Daytime](/images/pexels-photo-196666.jpeg "sample")
 
+
 ## Image with link
 
 [![2 People Sitting With View of Yellow Flowers during Daytime](/images/pexels-photo-196666.jpeg)](https://www.pexels.com/photo/2-people-sitting-with-view-of-yellow-flowers-during-daytime-196666/)
+
+
+## Definition Lists
+
+First Term
+: This is the definition.
+
+Second Term
+: This is the definition.
+: This is the definition.
+
+## Task Lists
+
+- [x] to do task 1
+- [ ] to do task 2
+- [ ] to do task 3
+
+## Footnotes
+
+this is a footnote,[^1] and this is a second footnote.[^2]
+
+[^1]: This is the first footnote.
+[^2]: This is the second footnote.
diff --git a/exampleSite/content/sample/build-in-shortcodes.md b/exampleSite/content/sample/build-in-shortcodes.md
@@ -30,10 +30,6 @@ See https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcod
 </section>
 {{< /highlight >}}
 
-## instagram
-
-{{< instagram BWNjjyYFxVx >}}
-
 ## tweet
 
 {{< tweet 877500564405444608 >}}

diff --git a/exampleSite/content/sample/markdown-syntax.md b/exampleSite/content/sample/markdown-syntax.md
@@ -0,0 +1,147 @@
+---
+title: "Markdown Syntax"
+date: 2020-11-17T15:26:15Z
+draft: false
+weight: 10
+description: "calling custom Shortcodes into your content files."
+---
+
+## Headings
+
+```markdown
+# Heading level 1
+## Heading level 2
+### Heading level 3
+#### Heading level 4
+##### Heading level 5
+###### Heading level 6
+```
+
+## Emphasis
+
+```markdown
+*Italic*  
+**Bold**  
+~~Strikethrough~~
+```
+
+## Horizontal Rule
+
+```markdown
+---
+```
+
+## Lists
+
+### Unordered Lists
+
+```markdown
+- First item
+- Second item
+- Third item
+- Fourth item
+```
+
+or
+
+```markdown
+* First item
+* Second item
+* Third item
+* Fourth item
+```
+
+### Ordered Lists
+
+```markdown
+1. First item
+2. Second item
+3. Third item
+4. Fourth item
+```
+
+## Code
+
+````markdown
+```ruby
+puts 'The best way to log and share programmers knowledge.'
+puts 'The best way to log and share programmers knowledge.'
+```
+````
+
+## Inline code
+
+```markdown
+`#ffce44`
+```
+
+## Blockquote
+
+```markdown
+> this is a blockquote. this is a blockquote. this is a blockquote. this is a blockquote. this is a blockquote. this is a blockquote.
+>
+> this is a blockquote.
+>
+> this is a blockquote.
+>
+> this is a blockquote
+```
+
+## Links
+
+```markdown
+[Hugo Techdoc Theme demo](https://themes.gohugo.io/theme/hugo-theme-techdoc/)
+```
+
+## Table
+
+```markdown
+| header | header | header |
+|------------|-------------|--------------|
+| Lorem      | Lorem       | Lorem        |
+| ipsum      | ipsum       | ipsum        |
+| dolor      | dolor       | dolor        |
+| sit        | sit         | sit          |
+| amet       | amet        | amet         |
+```
+
+## Images
+
+```markdown
+![2 People Sitting With View of Yellow Flowers during Daytime](/images/pexels-photo-196666.jpeg "sample")
+```
+
+
+## Image with link
+
+```markdown
+[![2 People Sitting With View of Yellow Flowers during Daytime](/images/pexels-photo-196666.jpeg)](https://www.pexels.com/photo/2-people-sitting-with-view-of-yellow-flowers-during-daytime-196666/)
+```
+
+## Definition Lists
+
+```markdown
+First Term
+: This is the definition.
+
+Second Term
+: This is the definition.
+: This is the definition.
+```
+
+## Task Lists
+
+```markdown
+- [x] to do task 1
+- [ ] to do task 2
+- [ ] to do task 3
+```
+
+## Footnotes
+
+```markdown
+this is a footnote,[^1] and this is the second footnote.[^2]
+
+[^1]: This is the first footnote.
+[^2]: This is the second footnote.
+```
diff --git a/package-lock.json b/package-lock.json