4016deb430
* Update README.md * Added documentation |
||
---|---|---|
archetypes | ||
exampleSite | ||
images | ||
layouts | ||
static | ||
.editorconfig | ||
.gitignore | ||
LICENSE.md | ||
Makefile | ||
README.md | ||
theme.toml |
README.md
A simple and clean blog theme for Hugo.
How to use this theme
To use hugo-coder
go through the following steps.
Download
Clone this repository into your Hugo project.
git clone https://github.com/luizdepra/hugo-coder.git themes/coder
Configuration
Add the following lines to your config.toml
.
baseurl = "http://www.example.com" # Hostname (and path) to the root.
title = "johndoe" # Site title.
theme = "coder" # Set the theme.
languagecode = "en" # The site’s language code.
paginate = 20 # Default number of pages per page in pagination.
canonifyurls = true # Enable to turn relative URLs into absolute.
pygmentsstyle = "b2" # Color-theme or style for syntax highlighting.
pygmentscodefencesguesssyntax = true # Enable syntax guessing for code fences without specified language.
[params] # theme parameters
author = "John Doe" # Author's name.
info = "Full Stack DevOps and Magician" # Author's job title or info.
description = "John Doe's personal website" # Site description.
keywords = "blog,developer,personal" # Site keywords.
disqusShortname = "yourdiscussshortname" # Enable or disable Disqus
# Wether you want to hide copyright and credits in the footer.
hideCredits = false
hideCopyright = false
# Custom CSS
custom_css = []
# Social links
[[params.social]]
name = "Github"
weight = 1
url = "https://github.com/johndoe/"
[[params.social]]
name = "Twitter"
weight = 2
url = "https://twitter.com/johndoe/"
[[params.social]]
name = "LinkedIn"
weight = 3
url = "https://www.linkedin.com/in/johndoe/"
# Menu links
[[menu.main]]
name = "Blog"
weight = 1
url = "/posts/"
[[menu.main]]
name = "About"
weight = 2
url = "/about/"
You can look at full working config.toml
inside the exampleSite folder.
Build & Test
To update or generate the minified CSS file:
make build
To build your site and test, run:
hugo server
To preview the exampleSite, run
make demo
The above command copies current state of the theme to exampleSite/themes and starts hugo with hugo serve -D (Go does not support Symlink directories)
Disqus
Add the following line to your config,
disqusShortname = "yourdiscussshortname"
When this is set, all posts are disqus enabled
You can disable comments for a post by adding the following to your page meta data.
disable_comments: true
To Do
- Tags, Categories and Series
License
Coder is licensed under the MIT license.
Author
Contributors
- Gabor Nagy
- Ihor Dvoretskyi
- Jan Baudisch
- Jiri Hubacek
- Khosrow Moossavi
- Maikel
- peterrus
- Ralf Junghanns
- tobaloidee
- Vlad Ionescu
- Niels Reijn
Special Thanks
- Gleen McComb, for his great article about custom pagination.
- All contributors, for every PR and Issue reported.