blob: 7c193efce11d8767e165d2be7c870fb8c4e42258 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
## Hugo Theme - SK1 (Skeleton 1)
Fully functional basic Hugo theme with no css, no javascript.
Intended for learning hugo theme structure and functions.
---
<!-- TOC -->
- [SK Themes](#sk-themes)
- [Walk Through](#walk-through)
- [Demo](#demo)
- [Install](#install)
- [Testing](#testing)
- [Hugo Features Implemented](#hugo-features-implemented)
- [Site Config](#site-config)
- [Contributors](#contributors)
- [Change Log](#change-log)
<!-- /TOC -->
### SK Themes
Theme|GitHub|Hugo|Demo|Description
---|---|---|---|---
SK1|[hugo-theme-sk1](//github.com/J-Siu/hugo-theme-sk1)|[SK1](//themes.gohugo.io/hugo-theme-sk1/)|[sk1.jsiu.dev](//sk1.jsiu.dev/)|Fully functional basic Hugo theme with no css, no javascript.
SK2|[hugo-theme-sk2](//github.com/J-Siu/hugo-theme-sk2)|[SK2](//themes.gohugo.io/hugo-theme-sk2/)|[sk2.jsiu.dev](//sk2.jsiu.dev/)|Fully functional basic Hugo theme with minimum css.
SK3|[hugo-theme-sk3](//github.com/J-Siu/hugo-theme-sk3)|[SK3](//themes.gohugo.io/hugo-theme-sk3/)|[sk3.jsiu.dev](//sk3.jsiu.dev/)|Full feature Hugo theme with Google AdSense support.
### Walk Through
[Hugo Theme SK1 Walk Through](https://johnsiu.com/blog/hugo-theme-sk1-walkthrough/) - A starting guide for creating Hugo theme.
### Demo
SK1 demo site: https://sk1.jsiu.dev/ with content from [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample).
### Install
In site directory:
- Using clone
```sh
git clone https://github.com/J-Siu/hugo-theme-sk1 themes/sk1
```
- Using submodule
```sh
git submodule add https://github.com/J-Siu/hugo-theme-sk1 themes/sk1
```
- Update submodule
```sh
git submodule update --recursive --remote
```
### Testing
```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.demo.toml \
--verbose
```
### Hugo Features Implemented
- layouts
- _default
- baseof.html
- [ ] No change, auto generated by Hugo
- list.html
- [x] `.Site.Params.mainSections` for home page listing.
- [x] Pagination
- single.html
- [x] Content
- [x] Date
- [x] Next/Prev
- [x] Related
- [x] Tags
- [x] ToC
- partials
- footer.html
- [x] Site.Params.copyright
- head.html
- [ ] No change, auto generated by Hugo
- header.html
- [x] Site.Params.subtitle
- 404.html
- [x] Text "Page Not Found."
- index.html
- [x] Deleted. Merged with list.html
### Site Config
```toml
baseURL = "https://sk1.jsiu.dev"
theme = "sk1"
title = "SK1"
[Params]
mainSections = "post"
subtitle = "A Hugo Theme"
```
### Contributors
- [John Sing Dao Siu](https://github.com/J-Siu)
### Change Log
- 1.0.0
- Initial Commit
- 1.0.1
- Add images
- README.md update
- Use site.Params.mainSections
|
