wantsum/README.md
2024-07-05 21:52:12 +01:00

118 lines
2.3 KiB
Markdown

# Wantsum
Wantsum is a minimalist two-column [hugo](https://gohugo.io) theme based on [Soho](https://github.com/alexandrevicenzi/soho)
![Screenshot](https://git.spod.cx/bcc/wantsum/raw/branch/main/images/screenshot.png)
![Dark Mode](https://git.spod.cx/bcc/wantsum/raw/branch/main/images/screenshot-dark.png)
## Features
- Mobile First
- Responsive
- Semantic
- SEO best practices
- Open Graph
- Schema.org (Microdata and JSON-LD)
- Pagination
- Customizable
- Support all [Hugo Internals](https://gohugo.io/templates/internal/)
- Dark Mode
- No external dependencies
## Installation
To install Wwantsum as your default theme, first install this repository in the `themes/` directory:
$ cd themes/
$ git submodule add https://git.spod.cx/bcc/wansum.git
Second, specify `wantsum` as your default theme in the `config.toml` file. Just add the line
theme = "wantsum"
at the top of the file.
## Configuration
```toml
baseURL = "https://example.com"
title = "Wantsum"
languageCode = "en"
enableInlineShortcodes = true
summarylength = 10
enableEmoji = true
[params]
author = "Author Name"
description = "My Blog"
## Set one of:
# gravatar = "wantsum@example.com"
profilePicture = "images/profile.png"
copyright = "Author Name"
license = "CC BY-SA 4.0"
licenseURL = "https://creativecommons.org/licenses/by-sa/4.0"
## Set custom theme color.
# themeColor = "#fc2803"
## Set custom CSS and/or JS to override site defaults.
customCss = ["css/blog.css"]
customJs = ["js/blog.js"]
## Set as many as you want.
[[params.socialIcons]]
icon = "brands/linkedin"
title = "Linkedin"
url = "#"
[[params.socialIcons]]
icon = "brands/github"
title = "GitHub"
url = "#"
[[params.socialIcons]]
icon = "brands/twitter"
title = "Twitter"
url = "#"
[menu]
[[menu.main]]
name = "Posts"
weight = 100
identifier = "posts"
url = "/posts/"
[[menu.main]]
name = "About"
identifier = "about"
weight = 300
url = "/about/"
[taxonomies]
category = "categories"
series = "series"
tag = "tags"
[markup]
[markup.highlight]
codeFences = true
guessSyntax = false
hl_Lines = ""
lineNoStart = 1
lineNos = false
lineNumbersInTable = true
noClasses = true # if false, you need to provide you own custom CSS
style = "monokai"
tabWidth = 4
```
## License
MIT