A clean and minimal Hugo theme.
Find a file
2022-02-18 10:34:06 +08:00
.github/workflows fix gh action 2021-08-23 22:20:39 +08:00
archetypes Initial commit 2021-07-18 16:34:01 +08:00
assets rss feeds 2022-02-17 18:18:35 +08:00
data add toc 2021-08-04 09:49:55 +08:00
docs docs 2022-02-17 19:55:29 +08:00
exampleSite demo site 2022-02-18 10:34:06 +08:00
images README 2022-01-26 22:45:45 +08:00
layouts rss feeds 2022-02-17 18:20:43 +08:00
static mermaid support 2021-08-19 12:42:47 +08:00
testdata rss feeds 2022-02-17 18:18:35 +08:00
.gitignore enable reading template variable from JS files 2021-08-23 21:40:38 +08:00
config.toml add 3 kinds of buttons to open toc content 2021-12-02 13:52:55 +08:00
LICENSE Initial commit 2021-07-18 16:34:01 +08:00
Makefile some styles fixes 2021-11-06 15:28:56 +08:00
README.md docs 2022-02-17 19:55:29 +08:00
theme.toml new feature: external link post 2022-01-30 15:12:29 +08:00

Minima

This project was originally a Hugo port of the Hexo Minima. A lot of changes have been made so far to make Minima cooler.

Links: Demo Site, Demo Configs, Author's Blog

The main branch is in development stage, UI or configuration may vary. You can use the latest stable version here.

screenshot

Features

  • Clean
  • Light/dark mode
  • VSCode-style code hightlighting (the most alike among all Hugo themes)
  • KaTeX
  • Mermaid diagrams
  • Google analytics
  • Disqus/Utterances
  • Optional ToC
  • External link post
  • RSS

Usage

Before using Minima, make sure you've got Hugo (extended version) installed on your device.

Installation

Suppose blog is where you place your sources.

cd blog
git init
git submodule add --depth 1 https://github.com/mivinci/hugo-theme-minima.git themes/minima

Or clone directly if you don't wanna use the Git submodule.

git clone https://github.com/mivinci/hugo-theme-minima.git themes/minima

Anyways, you just need to put Minima under the blog/themes directory.

Configuration

Follow exampleSite/config.toml and edit your own blog/config.toml file.

Supported Front Matters

Field Type Explanation
title string Title of the post
description string Description of the post
date string Datetime when the post is written
link string If set, the post will redirect to an external link
categories array Array of categories the posts belongs to
series array Array of series the post belongs to
tags array Array of tags the posts is related to
math bool True if the post needs to render math formulas
mermaid bool True if the post needs to render mermaid diagrams
comment bool True if the post allows people to make comments
draft bool True if the post isn't already for publishing
toc bool True if the post needs a ToC

External Link Post

Use the link in the front matter to make a post a specific external link. Such external link post will redirect to the link provided.

Example

---
author: XJJ
title: External Link Post
date: 2021-07-17T10:52:59+08:00
link: https://gohugo.io
---

And when you click the title in the list page, you will be redireted to https://gohugo.io, which's 🆒.

RSS Feeds

v1.1.0 and later versions support subscription to external RSS feeds whereas titles and links to your friends' posts can be displayed in your blog site. For details, see friends in the configuaration

Example

[params.friends]
feeds = ["https://xjj.pub/index.xml"]
topk = 3
title = "Friends' Posts"

Feedback

Feedbacks are welcome here.