0xflotus / hugo-theme-sk3 Goto Github PK

Full feature Hugo theme build on top of hugo-theme-sk2 with Google AdSense support.

• SK Themes
• Sites
• Install
• Testing
• Features
• Layout
  • Markdown Style
  • Site
    • Main Section Type
    • Table of ContentToc Open By Default
    • Favicon
    • Sub-Title
    • Copyright Start Year
    • Page Width
    • List Last Modify Date
    • Custom CSS
    • Custom Javascript
    • User-declared Canonical
    • SVG External
  • Social Links
  • Social Share
  • Color Theme
  • Card/List
  • Google AdSense
  • Twitter Cards / Opengraph
  • Page Info Style
  • Per Page
• Sample Config
• Font Awesome
• Thank You
• Contributors
• Change Log
• License

John Siu Blog: johnsiu.com

SK3 demo site: sk3.jsiu.dev with content from hugoBasicExample

In site directory:

• Using clone

  git clone https://github.com/J-Siu/hugo-theme-sk3 themes/sk3

• Using submodule

  git submodule add https://github.com/J-Siu/hugo-theme-sk3 themes/sk3

• Update submodule

  git submodule update --recursive --remote

git clone https://github.com/J-Siu/hugo-theme-sk3 sk3
cd sk3

# Pull example site.
git submodule update --recursive --init

cd exampleSite
hugo server -D --bind :: \
--disableFastRender \
--theme sk3 \
--themesDir ../../ \
--config config.toml,../config.demo.toml \
--verbose

• Blog
• Custom CSS
• Custom Javascript
• Customizable
• Disqus
• Google Adsense
• Google Analytics
• Minimalist Design
• Responsive
• Social Links
• Social Share

Headline in markdown should start at level 3 (###), as site title is H1 and page title is H2.

For generating homepage list. Hugo default to section with most entries.

[Params]
mainSections = "post"

[Params]
openToc = true

Path of favicon of the published site.

If favicon logo.svg is put inside static like following:

./
├── archetypes/
├── content/
├── public/
├── resources/
├── static/
│   └── logo.svg
├── themes/
└── config.toml

The final path will be /logo.svg:

[Params]
favicon = "/logo.svg"

SK themes come with default favicon. To disable it:

# At Hugo site root
touch static/favicon.ico

If defined, sub-title appear after site title in smaller font.

[Params]
subtitle  = "A Hugo Themes"

Year is extracted from startdate and generate copyright in format "2012-(current year)".

Site copyright override this behavior.

[Params]
startdate = "2012-12-02"

default: 1200px

[Params]
pagewidth = "1200px"

Page width will automatically set to 100% on small screen.

Use last modify date in list page.

[Params]
listlastmod	= true

If you add custom css files like following:

./
├── archetypes/
├── content/
├── public/
├── resources/
├── static/
│   └── css/
│       ├── abc.css
│       └── def.css
├── themes/
└── config.toml

The final path of your css files will be /css/abc.css and /css/def.css:

[Params]
custom_css = ["/css/abc.css", "/css/def.css"]

If you add custom javascript like following:

./
├── archetypes/
├── content/
├── public/
├── resources/
├── static/
│   └── js/
│       ├── abc.js
│       └── def.js
├── themes/
└── config.toml

The final path of your javascript files will be /js/abc.js and /js/def.js:

[Params]
custom_js = ["/js/abc.js", "/js/def.js"]

Only use this if site require user-declared canonical meta. This is not related to Hugo Canonicalization nor canonifyurls.

[Params]
user_canonical = true

A rel="canonical" meta link with absolute URL will be added to each page.

Set svg_ext to true will load social icon using Font Awesome external css.

[Params]
svg_ext = true

Social link buttons appear at the bottom of card/list page:

[Params.sociallink]
  facebook       = ""
  flickr         = ""
  instagram      = ""
  linkedin       = ""
  pinterest      = ""
  reddit         = ""
rss            = true
  tumblr         = ""
  twitter        = ""
  vimeo          = ""
  youtubechannel = ""
  youtubeuser    = ""

Social share buttons appear at the bottom of regular page:

[Params.socialshare]
  facebook  = true
  instagram = true
  linkedin  = true
  pinterest = true
  reddit    = true
  telegram  = true
  twitter   = true
  vk        = true

• Default dark theme

  Change color theme directly in config.toml.

  Default in CSS:

  [Params.color]
  bg     = "#181a1b"
  border = "white"
  link   = "#3d84ff"
  text   = "white"

  Following is a light theme

  [Params.color]
  bg     = "white"
  border = "black"
  link   = "#3d84ff"
  text   = "black"

• Width (default:32% on computer screen)

  32% gives 3 columns, 24% gives 4 columns, etc. 100% basically turn into list mode.

• Date

• Summary

  [Params.card]
    date    = true
    summary = true
    width   = "32%"

• Support Google AdSense auto:

  [Params]
  adsense_id = ""

Use following to enable Twitter Cards / Opengraph:

This should be enabled in general as Google search also pick up the same meta tags.

[Params]
opengraph   = true
twitercards = true
description = "site description"
title       = "site title"

Page info can be in box style.

[Params]
pageinfobox = true

• Disable Disqus

• Disable Prev/Next

• Disable Related

• Disable Table of Content

  To disable the above, in front matter:

  comment = false
  prevnext = false
  related = false
  toc = false

config.sample.toml located in theme dir.

baseURL = "https://"
theme   = "sk3"
title   = ""

enableGitInfo = true
DefaultContentLanguage = "en"
enableInlineShortcodes = true
languageCode           = "en"
paginate               = 15

#disqusShortname = ""
#googleAnalytics = ""

[Params]
#adsense_id     = ""
#custom_css     = ["/css/abc.css", "/css/def.css"]
#custom_js      = ["/js/abc.js", "/js/def.js"]
#favicon        = "/favicon.ico"
#listlastmod    = true
#mainSections   = "post"
#pagewidth      = "1200px"
#startdate      = "2012-12-02"
#subtitle       = "A Hugo Theme"
#svg_ext        = true
#user_canonical = false

# Fill in following if using opengraph / twitter card
#opengraph   = true
#twitercards = true
#description = "A Hugo Theme"
#title       = "SK3"

  [Params.card]
  date    = true
  summary = true
  #width  = "32%"

	# [Params.color]
	# bg     = "#181a1b"
	# border = "white"
	# link   = "#3d84ff"
	# text   = "white"

	# [Params.sociallink]
	# facebook       = ""
	# flickr         = ""
	# github         = ""
	# instagram      = ""
	# linkedin       = ""
	# pinterest      = ""
	# reddit         = ""
	# stack-exchange = ""
	# stack-overflow = ""
	# tumblr         = ""
	# twitter        = ""
	# vimeo          = ""
	# youtubechannel = ""
	# youtubeuser    = ""

  [Params.socialshare]
  facebook  = true
  instagram = true
  linkedin  = true
  pinterest = true
  reddit    = true
  telegram  = true
  twitter   = true
  vk        = true

[markup]
  [markup.tableOfContents]
  endLevel   = 6
  startLevel = 1

Social buttons provided by Font Awesome Brands(free).

fa-svg-extract.sh is used to extract icon from Font Awesome sprites/brands.svg and sprites/solid.svg.

./fa-svg-extract.sh brands.svg > sk3-fa.svg
./fa-svg-extract.sh solid.svg >> sk3-fa.svg

• SK3 inspired by Vimux/Binario. Check it out too!

• John Sing Dao Siu

• 0.8.5
  • Initial Commit
• 0.8.6
  • Share button in menu
  • Fixed
    • Adsense ID
    • CSS color conflict with syntax highlight
    • Display issue with Disqus
    • Display issue with prev/next
    • Unwanted title on homepage
• 0.8.7
  • CSS clean up
  • Complete README.md
  • Default page width 1200px
  • Default card width 32%
  • Fixed menu bar top and left "leaking"
• 0.8.8
  • CSS clean up
  • Improve header
  • Improve README.md
  • Fix margin/padding
• 0.8.9
  • CSS / spacing update
  • Include config.sample.toml
  • Use Font Awesome web font
• 0.9.0
  • Switch to Font Awesome SVG
• 0.9.1
  • Add box style page info
  • CSS clean up
  • Do not render empty table of content
  • Fix highlight font conflict
• 0.9.2
  • Add images
  • Demo config
  • Fix css
  • Improve menu
  • README.md update
  • Template .Site. -> site.
  • Use site.Params.mainSections
• 0.9.3
  • Click anywhere to close menu
  • SVG external option
• 0.9.4
  • Fix css spacing, kbd, social buttons, author box
  • Fix menu closing click through
• 0.9.5
  • Add listlastmod
  • Fix H1 line height
  • Fix Google Analytics
  • Fix table for mobile screen
  • Refactor css margin/padding/font size
• 0.9.6
  • Add default favicon.ico
  • Remove H1 from header.html & menu.html (Bing SEO)
  • Standardize .Site. -> site.
  • Update README.md
• 0.9.7
  • Add custom css and js support
  • Add open toc by default
  • Add page related (enable/disable)
  • Add user-declared canonical support
  • Fix footer alignment
  • Update favicon instructions
• 0.9.8
  • Add box to current list page button
  • Add external link open in new tab
  • Add rss
  • CSS cleanup
  • Center images
  • Fix <head> description, title
  • Fix html issues
  • Homepage title larger
  • Sort tags list / in page
  • Sticky menu button

The MIT License (MIT)

Copyright (c) 2020 John Siu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.