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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# Hugo W3 SIMPLE
## _Keep it simple, but not simpler_
**Hugo W3 Simple** is a Hugo theme written by [Jesse Lau](https://jesselau.com) . The main motivation for writing this theme was to provide a really minimal theme with W3 CSS included.
## Features:
- W3.css - small and fast
- Responsive
- W3 code color js - small and fast code highlight solution.
- Twitter Card
- Google Analytics
- Disqus
- One Signal Push
- Social share & Bookmark bar
- Shortcodes:Info, Warning, Colorcode. [Demo Here](https://jesselau.com/w3-simple-shortcodes-demo/)
- Sphinx or Manticore search supported. Output xml file which can be indexed by sphinx and manticore search. Example site can not include search function because it need server-side setting. [Live Search function Demo Here](https://jesselau.com/search/)
- Table of content and back to top button on scroll.
- Grid style and simple list style.
- All posts in one page. With a filterable, sortable and responsive table powered by w3.js. [Live Demo Here.](https://jesselau.com/allposts/)
- Google translate.
- Social icon.
- Multilingual.
## Screenshot
### Grid style
### Simple list style
### All posts in one page. With a filterable, sortable and responsive table
## Install:
```bash
cd themes
git clone https://github.com/jesselau76/hugo-w3-simple.git
```
## How to configure?
It is very simple. You can edit the example **config. toml** file from examplesite or below
```bash
baseurl = "https://example.com/"
languageCode = "en-us"
title = "Hugo W3 Simple Theme"
theme = "hugo-w3-simple"
disqusShortname = "" # disqus_shortname
googleAnalytics = "" # UA-XXXXXXXX-X
paginate = 12 #gridstyle use 3 column. so should be 3,6,9,12,15....
hasCJKLanguage = true # has chinese/japanese/korean ?
[[menu.main]]
name = "About"
url = "/about/"
weight = 2
[[menu.main]]
name = "Categories"
url = "/categories/"
weight = 3
[[menu.main]]
name = "Tags"
url = "/tags/"
weight = 4
[[menu.main]]
name = "All Posts"
url = "/allposts/"
weight = 5
[params]
authorandlicense = true
authorimgurl = "https://raw.githubusercontent.com/jesselau76/hugo-w3-simple/master/exampleSite/images/johndoe.jpg" #if authorandlicense set true, this one must be set too
authorinfo = "<h4>Authored By John Doe</h4>"
licenseinfo = "<p class=\"w3-small\">John Doe, a good man living in the earth, loving building website with Hugo.<br>This article is licensed under a <a rel=\"license\" href=\"https://creativecommons.org/licenses/by/4.0/\" class=\"w3-text-white\">Creative Commons Attribution 4.0 International License</a>.</p>"
relatedPosts = true
backtotop = true
gridstyle = true # list post with grid style. If false then simple list
readingtime = true #display reading time and word count
firstpic = true # display first picture as thumbnail if no thumbnail set. For gridstyle only
socialshare = true
searchfunction = false #If you need search button and you have search function please set true
description = "Hugo W3 Simple Theme"
onesignalid = "" #one signal push app id
logotext = "HUGO W3 SIMPLE" # logo text
footer = "© [John Doe](https://johndoe.com) 2018 | [Github](https://github.com/johndoe) | [Twitter](https://twitter.com/johndoe) | [RSS](/index.xml)"
[params.social] # Set your social account here, if you don't have some accounts just comment them
a-envelope = "mailto:your@email.com"
b-stack-overflow ="https://stackoverflow.com/users/12345678/john-doe"
c-twitter = "https://twitter.com/johndoe"
d-facebook = "https://www.facebook.com/johndoe"
e-github = "https://github.com/johndoe"
f-youtube = "https://www.youtube.com/channel/12345678"
g-linkedin = "https://www.linkedin.com/johndoe"
h-google = "https://plus.google.com/12345678"
i-github = "https://github.com/johndoe"
j-weibo = "https://weibo.com"
k-weixin = "http://localhost:1313"
l-tumblr = "https://www.tumblr.com/blog/johndoe"
m-instagram = "https://instagram.com/johndoe"
n-gitlab = "https://gitlab.com/johndoe"
o-pinterest = "https://www.pinterest.com/johndoe/"
```
## Search Page
To use search function, you need create `./content/search/index.md` file. Please see exampleSite folder.
## All posts
To use all posts function, you need create `./content/allposts/_index.md` file. Please see exampleSite folder.
## Favicon
In order to customize the favicon you need to place the `favicon.ico` file in the static folder at the root of your site, which will overwrite those files in the themes/even/static/ folder.
## Update Theme
```bash
cd themes/hugo-w3-simple/
git pull
```
## License
Released under the [MIT](https://github.com/jesselau76/hugo-w3-simple/blob/master/LICENSE) License.
## Acknowledgements
- [Hugo Xmin](https://github.com/yihui/hugo-xmin)
- [Even](https://github.com/olOwOlo/hugo-theme-even)
- [Mediumish](https://github.com/lgaida/mediumish-gohugo-theme)
|
