README.md

Tex(h)ugo 🦡

Minimalistic website theme for Hugo based on Tex's typography. Live preview available here

Home	Post

Getting Started

Clone this repository inside your Hugo project theme directory.

$ mkdir themes
$ cd themes
$ git clone https://github.com/antonioalmeida/texugo-theme.git

Configuration

Take a look at the /exampleSite directory.

Copy the config.toml to the root directory of your website and overwrite the existing information as needed:

config.toml:

baseurl = "https://example.com"
languageCode = "en"
title = "Texugo"
theme = "texugo-theme"
copyright = "© John Doe 2020"

[params]
    nickname = "johndoe"
    name = "John Doe"
    bio = ["Human being", "Not an animal", "a third thing"]

[[params.social]]
  name = "Github"
  url = "https://example.com"

[[params.social]]
  name = "Twitter"
  url = "https://example.com"

[[params.social]]
  name = "LinkedIn"
  url = "https://example.com"

[markup]
  [markup.highlight]
    codeFences = true
    guessSyntax = false
    hl_Lines = ""
    lineNoStart = 1
    lineNos = false
    lineNumbersInTable = true
    noClasses = true
    style = "github"
    tabWidth = 4

Development

# run local server (localhost:1313)
$ hugo server

# make production build (/public)
$ hugo --minified

Deployment

• Check this repository as an example on how to deploy via Github Actions.

Inspired by

• Tex
• WiTex
• Charaka

Tweaking the theme

• Set up and activate as your website's theme
• Inside the theme directory install dependencies: $ npm install
• Make required changes to style.scss and run $ npm run css-build && npm run css-watch to live update your changes

License

tex-hugo-theme is licensed under the MIT License.

Author

António Almeida