README.md 2.4KB

Toromino-Hugo-Theme

Toromino-Hugo-Theme is based on Nix, a simple & minimal theme for Hugo.

Usage

Clone the repository to your hugo theme directory.

mkdir themes
cd themes
git clone https://git.cybre.club/Foxhkron/Toromino-Hugo-Theme.git

Configuration

Add these parameters to your config.toml:

[params]
  GnuPGFingerprint = "your_gpg_fingerprint"
  StackExchangeID = "your_stackexchange_id"
  StackOverflowID = "your_stackoverflow_id"
  GithubID = "your_github"
  GitlabId = "your_gitlab"
  BitbucketID = "your_bitbucket_id"
  TwitterID = "your_twitter"
  CodepenID = "your_codepen"
  LinkedInID = "your_linkedin"
  GoogleplusID = "your_googleplus"
  FacebookID = "your_facebook"
  InstagramID = "your_instagram"
  TelegramID = "your_telegram"
  Name = "your_name"
  HeaderUsername = "username"
  HeaderHostname = "hostname"
  Email = "your_email"
  Phone = "+1-201-555-0123"
  Mobile = "+1-201-555-0123"
  About = "info_about_you"
  ProfilePicture = "profile_picture_url"
  GoogleAnalytics = "your_google_analytics_id"
  SlackURL = "https://join.slack.com/..."
  PayPalMeID = "https://www.paypal.me/..."
  XingURL = "https://www.xing.com/profile/..."
  CvURL = "your_cv_url"
  KeybaseID = "your_keybase_id"
  XMPPID = "your_xmpp_id"
  GiteaURL = "url_to_your_gitea_profile"

Edit them as needed. If you don't want one of the social networks or Google Analytics simply delete that line. HeaderUsername and HeaderHostname will be displayed in navbar on left side in the format: HeaderUsername@HeaderHostname ~ $

To add a menu item add menu.header item to config.toml. For example:

[menu]
  menu.header
    name = "posts"
    weight = 0
    url = "/posts"

To add a submenu item add menu.header item with a parent parameter to config.toml. For example:

[menu]
  menu.header
    identifier = "post"
    name = "posts"
    weight = 0
    url = "/post"
  menu.header
    parent = "post"
    name = "All Posts"
    url = "/post"
  menu.header
    parent = "post"
    name = "categories"
    url = "/categories"
  menu.header
    parent = "post"
    name = "tags"
    url = "/tags"

To enable disqus comments add disqusShortname to your config.toml.

You can turn off disqus comments per page by adding nocomments = true to the front matter.

License

Toromino-Hugo-Theme is licensed under the MIT License