Hugo Theme - SK1 (Skeleton 1)

Fully functional basic Hugo theme with no css, no javascript.

Intended for learning hugo theme structure and functions.

Table Of Content

• SK Themes
• Walk Through
• Demo
• Install
• Testing
• Hugo Features Implemented
• Site Config
• Default Favicon
• Contributors
• Change Log
• License

SK Themes

Walk Through

Hugo Theme SK1 Walk Through - A starting guide for creating Hugo theme.

Demo

SK1 demo site: https://sk1.jsiu.dev/ with content from hugoBasicExample.

Install

In site directory:

• Using clone

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

• Using submodule

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

• Update submodule

  git submodule update --recursive --remote
  

Testing

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
      • .Site.Params.mainSections for home page listing.
      • Pagination
    • single.html
      • Content
      • Date
      • Next/Prev
      • Related
      • Tags
      • ToC
  • partials
    • footer.html
      • Site.Params.copyright
    • head.html
      • No change, auto generated by Hugo
    • header.html
      • Site.Params.subtitle
  • 404.html
    • Text “Page Not Found.”
  • index.html
    • Deleted. Merged with list.html

Site Config

baseURL = "https://sk1.jsiu.dev"
theme   = "sk1"
title   = "SK1"

[Params]
mainSections = "post"
subtitle = "A Hugo Theme"

Default Favicon

SK themes come with default favicon.

Disable default favicon:

# At Hugo site root
touch static/favicon.ico

Override default favicon:

# At Hugo site root
cp <your favicon.ico> static/favicon.ico

Contributors

• John Sing Dao Siu

Change Log

• 1.0.0
  • Initial Commit
• 1.0.1
  • Add images
  • README.md update
  • Use site.Params.mainSections
• 1.0.2
  • Add default favicon.ico
  • Add walk through
  • Change toc start level to 1
  • Update README.md

License

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.