Go to file
Jan Baudisch d69c5cfef3 Update footer to be optional (#20)
* Update footer to be optional

* Update example with optional footer

* Update README with optional footer
2018-05-09 21:06:16 -03:00
archetypes Fix links and content type 2018-03-08 16:48:46 -03:00
exampleSite Update footer to be optional (#20) 2018-05-09 21:06:16 -03:00
images Initial files 2018-02-28 22:38:59 -03:00
layouts Update footer to be optional (#20) 2018-05-09 21:06:16 -03:00
static Change link styles when in a post (#15) 2018-05-01 19:55:12 -03:00
.editorconfig Add Makefile to build CSS 2018-03-23 16:49:06 -03:00
.gitignore Disqus support, exampleSite preview through make commando (#16) 2018-05-01 15:59:02 -03:00
LICENSE.md Initial files 2018-02-28 22:38:59 -03:00
Makefile Disqus support, exampleSite preview through make commando (#16) 2018-05-01 15:59:02 -03:00
README.md Update footer to be optional (#20) 2018-05-09 21:06:16 -03:00
theme.toml Fix links and content type 2018-03-08 16:48:46 -03:00

README.md

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

[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

    # wether you want to hide copyright and credits in the footer
    hideCredits = false
    hideCopyright = false
    
# 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

Luiz de Prá

Special Thanks

  • Gleen McComb, for his great article about custom pagination.
  • All contributors, for every PR and Issue reported.