hugo-coder-fork/README.md

2.0 KiB

hugo-coder

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.

theme = "coder" # set the theme

[permalinks] # configure post and fixed pages permalinks
    post = "posts/:title/"
    default = ":title/"

[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
    
# 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 build your site and test, run:

hugo server

To Do

  • Comments (probably not Disqus, sorry)
  • Tags, Categories and Series

License

Coder is licensed under the MIT license.

Author

Luiz de Prá

Special Thanks

  • Gleen McComb, for his great article about custom pagination.