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-07-03 06:30:39 +0300
committerJohn Siu (imacpro) <john.sd.siu@gmail.com>2020-07-03 06:30:39 +0300
commit4299729cfa25f505406f56b8e376e1686410fbb8 (patch)
tree4206508029eeae9684d2a2729638ff45da17e196
parent0a4810de05b8ad7250c9a8612cf4520d1ea8fb23 (diff)
README.md - 1.0.11.0.1
-rw-r--r--README.md83
1 files changed, 43 insertions, 40 deletions
diff --git a/README.md b/README.md
index 8e49340..b544be1 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,41 @@
## Hugo Theme - SK1 (Skeleton 1)
-Fully functional basic Hugo theme, html only, no css, no javascript.
+Fully functional basic Hugo theme with no css, no javascript.
-Intended for learning hugo theme, or as a skeleton to develop full feature theme.
+Intended for learning hugo theme structure and functions.
### Demo
-SK2 demo site: https://sk1.jsiu.dev/
+SK1 demo site: https://sk1.jsiu.dev/
-Example site content from [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample)
+SK1 demo site content from [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample)
-### Usage
+### Install
-- Clone
+In site directory:
- In site directory:
+- Using clone
- ```sh
- git clone https://github.com/J-Siu/hugo-theme-sk1 theme/sk1
- ```
+ ```sh
+ git clone https://github.com/J-Siu/hugo-theme-sk3 theme/sk3
+ ```
-- Submodule
+- Using submodule
- In site directory:
+ ```sh
+ git submodule add https://github.com/J-Siu/hugo-theme-sk3 theme/sk3
+ ```
- ```sh
- git submodule add https://github.com/J-Siu/hugo-theme-sk1 theme/sk1
- ```
+- Update submodule
-### Testing
+ ```sh
+ git submodule update --recursive --remote
+ ```
-In `exampleSite`:
+### Testing
```sh
-git clone https://github.com/J-Siu/hugo-theme-sk1 sk1
+git clone https://github.com/J-Siu/hugo-theme-sk3 sk1
cd sk1
# Pull example site.
@@ -44,7 +46,7 @@ hugo server -D --bind :: \
--disableFastRender \
--theme sk1 \
--themesDir ../../ \
---config config.toml,../config.sk1.toml \
+--config config.toml,../config.demo.toml \
--verbose
```
@@ -53,41 +55,38 @@ hugo server -D --bind :: \
- layouts
- _default
- baseof.html
- - No change, auto generated by Hugo
+ - [ ] No change, auto generated by Hugo
- list.html
- - `Site.Params.maintype` for home page listing. Default: `post`
- - Pagination
+ - [x] `.Site.Params.mainSections` for home page listing.
+ - [x] Pagination
- single.html
- - Content
- - Date
- - Next/Prev
- - Related
- - Tags
- - ToC
+ - [x] Content
+ - [x] Date
+ - [x] Next/Prev
+ - [x] Related
+ - [x] Tags
+ - [x] ToC
- partials
- footer.html
- - Site.Params.copyright
+ - [x] Site.Params.copyright
- head.html
- - No change, auto generated by Hugo
+ - [ ] No change, auto generated by Hugo
- header.html
- - Site.Params.subtitle
+ - [x] Site.Params.subtitle
- 404.html
- - Text "Page Not Found."
+ - [x] Text "Page Not Found."
- index.html
- - Deleted. Merged with list.html
+ - [x] Deleted. Merged with list.html
### Site Config
```toml
baseURL = "https://sk1.jsiu.dev"
-title = "SK1"
-
-enableGitInfo = false
-relativeURLs = true
-theme = "sk1"
+theme = "sk1"
+title = "SK1"
[Params]
-maintype = "post"
+mainSections = "post"
subtitle = "A Hugo Theme"
```
@@ -102,4 +101,8 @@ subtitle = "A Hugo Theme"
### Change Log
- 1.0.0
- - Initial Commit \ No newline at end of file
+ - Initial Commit
+- 1.0.1
+ - Add images
+ - README.md update
+ - Use site.Params.mainSections \ No newline at end of file