Skip to content
Basic personal site theme styled with minimal tachyons, syntax highlighting, and blog series configuration. πŸ“¦
Branch: master
Clone or download
siegerts Merge pull request #4 from ldav1s/master
Remove twitter meta when twitter not set.  Fix stray html end tag.  Remove body and html end tags from footer.
Latest commit 4f46496 Apr 5, 2019

README.md

hugo-theme-basic

Basic personal site theme styled with minimal tachyons, syntax highlighting, and blog series configuration.

Demo

https://hugo-theme-basic.netlify.com/

Screenshot

Features

  • ✨ Basic β€” HTML with a dash of style + emoji
  • 🌯 Extensible β€” Easily leverage tachyons to add more spice
  • πŸ—žοΈ series taxonomy - Automatically group posts and display within an isolated taxonomy type
  • πŸ₯‘ Syntax Highlighting - It's there when you need it

Installation

Run this command from the root of your Hugo directory (Git needs to be installed):

$ git clone https://github.com/siegerts/hugo-theme-basic.git

Or, if your Hugo site is already in git, you can include this repository as a git submodule. This makes it easier to update this theme (and for some deployment options i.e. Netlify).

$ git submodule add https://github.com/siegerts/hugo-theme-basic.git themes/hugo-theme-basic

Alternatively, if you are not familiar with git, you can download the theme as a .zip file, unzip the theme contents, and then move the unzipped source into your themes directory.

For more information, read the official documentation of Hugo.

Run example site

From the root of themes/hugo-theme-basic/exampleSite:

hugo server --themesDir ../..

Configuration

Check out the sample config.tomlfile located in the exampleSite directory. Copy the config.toml to the root directory of your Hugo site, then edit as desired.

Content Types

Type Description Command
Post Used for blog posts. Posts are listed on the /post page. hugo new post/<post-name>.md
Page Used for site pages. hugo new <page-name>.md
Project Used for project pages. Extend project list by customizing /layouts/section/project.html. hugo new project/<project-name>.md

Blog post series

An extra taxonomy, series, is added to allow for the grouping of blog posts. A Read More section shows at the bottom of each post within the series when two or more posts are grouped.

[taxonomies]
  category = "categories"
  series = "series"
  tag = "tags"

Series read more

.Params.Menu

Menu links are specified, in order, in the theme configuration.

For example:

[[params.menu]]
  name = "blog"
  url = "blog/"

[[params.menu]]
  name = "post series"
  url = "series/"

[[params.menu]]
  name = "about"
  url = "about/"

Syntax highlighting

Syntax highlighting is provided by highlight.js. The color theme can be changed by modifying the highlight.js stylesheet in layouts/partials/head_includes.html.

Acknowledgments

License

The code is available under the MIT license.

You can’t perform that action at this time.