guest@cmj0121.github.io: ~/posts $

Coder


how to use the Coder theme

This is the documentation for the Coder theme. It is designed to be used with the Coder . You can find the source code at GitHub and see the demo site at GitHub Pages .

Installation

Inside the folder of your Hugo site run and:

  1. run git clone https://github.com/cmj0121/hugo-theme-coder.git themes/coder.
  2. modify your config.toml file and add theme = "coder".

after that, you can run your Hugo site with this theme by hugo server command.

Configuration

You can configure the site with the following parameters in your config.toml file:

[params]
  username = "root"
  hostname = "example.com"

  minTermsCount = 1
ParameterDescription
usernameusername shown in the menu bar
hostnamehostname shown in the menu bar
minTermsCountthe minimal count of terms will be shown in list

Author

You can also specified the author information in the config.toml file:

  [params.author]
    username = "cmj"
    hostname = "example.com"

by default, the author information will be used in the header of the page, and coder will try to merge the author information with the params information.

Hero

You can also specified the hero icon in the config.toml file, it will be shown in the header of the page by the fontawesome icon:

  [params.hero]
    enabled = true
    icon = "user-secret"