Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/J-Siu/hugo-theme-sk1.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Siu (imacpro) <john.sd.siu@gmail.com>2020-06-29 03:25:00 +0300
committerJohn Siu (imacpro) <john.sd.siu@gmail.com>2020-06-29 03:25:00 +0300
commiteaedc84837c5fccec23c646434586960c506eca3 (patch)
treea1a4a2fdb706ce6e888f1ae894ff5466db7fd2aa
parentb8240069ad761a05f27a5b8626c6471edb3b7952 (diff)
Minor update.
-rw-r--r--README.md47
-rw-r--r--config.sk1.toml67
2 files changed, 53 insertions, 61 deletions
diff --git a/README.md b/README.md
index 0caa542..8e49340 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
-Hugo Theme - SK1 (Skeleton 1)
-
----
+## Hugo Theme - SK1 (Skeleton 1)
Fully functional basic Hugo theme, html only, no css, no javascript.
Intended for learning hugo theme, or as a skeleton to develop full feature theme.
+### Demo
+
+SK2 demo site: https://sk1.jsiu.dev/
+
+Example site content from [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample)
+
### Usage
-- Git clone
+- Clone
In site directory:
@@ -16,7 +20,7 @@ Intended for learning hugo theme, or as a skeleton to develop full feature theme
git clone https://github.com/J-Siu/hugo-theme-sk1 theme/sk1
```
-- Git submodule
+- Submodule
In site directory:
@@ -24,6 +28,26 @@ Intended for learning hugo theme, or as a skeleton to develop full feature theme
git submodule add https://github.com/J-Siu/hugo-theme-sk1 theme/sk1
```
+### Testing
+
+In `exampleSite`:
+
+```sh
+git clone https://github.com/J-Siu/hugo-theme-sk1 sk1
+cd sk1
+
+# Pull example site.
+git submodule update --recursive --init
+
+cd exampleSite
+hugo server -D --bind :: \
+--disableFastRender \
+--theme sk1 \
+--themesDir ../../ \
+--config config.toml,../config.sk1.toml \
+--verbose
+```
+
### Hugo Features Implemented
- layouts
@@ -56,22 +80,17 @@ Intended for learning hugo theme, or as a skeleton to develop full feature theme
```toml
baseURL = "https://sk1.jsiu.dev"
-title = ""
+title = "SK1"
enableGitInfo = false
relativeURLs = true
-theme = "hugo-theme-sk1"
+theme = "sk1"
[Params]
-copyright = ""
-maintype = ""
-subtitle = ""
+maintype = "post"
+subtitle = "A Hugo Theme"
```
-### Demo
-
-- https://sk1.jsiu.dev/
-
### Repository
- [hugo-theme-sk1](https://github.com/J-Siu/hugo-theme-sk1)
diff --git a/config.sk1.toml b/config.sk1.toml
index 7f8bd8a..034567e 100644
--- a/config.sk1.toml
+++ b/config.sk1.toml
@@ -1,53 +1,26 @@
baseURL = "https://sk1.jsiu.dev"
-title = "SK1"
-theme = "sk1"
+theme = "sk1"
+title = "SK1"
-author = "Steve Francia"
-copyright = "Copyright © 2008–2019, Steve Francia and the Hugo Authors; all rights reserved."
-paginate = 3
-languageCode = "en"
DefaultContentLanguage = "en"
+author = "Steve Francia"
+copyright = "Copyright © 2008–2019, Steve Francia and the Hugo Authors; all rights reserved."
+enableGitInfo = false
enableInlineShortcodes = true
-
-[menu]
-
- [[menu.main]]
- identifier = "about"
- name = "About"
- url = "/about/"
- weight = 10
-
-[taxonomies]
-category = "categories"
-tag = "tags"
-series = "series"
-
-[privacy]
-
- [privacy.vimeo]
- disabled = false
- simple = true
-
- [privacy.twitter]
- disabled = false
- enableDNT = true
- simple = true
-
- [privacy.instagram]
- disabled = false
- simple = true
-
- [privacy.youtube]
- disabled = false
- privacyEnhanced = true
-
-[services]
-
- [services.instagram]
- disableInlineCSS = true
-
- [services.twitter]
- disableInlineCSS = true
+languageCode = "en"
+paginate = 3
+relativeURLs = true
[Params]
-subtitle = "A Hugo Themes"
+maintype = "post"
+subtitle = "A Hugo Theme"
+
+[menu]
+ [[menu.main]]
+ identifier = "about"
+ name = "About"
+ url = "/about/"
+ weight = 10
+ [[menu.main]]
+ name = "Tags"
+ url = "/tags/"