hugo-theme-minima/README.md
2022-11-09 20:51:50 +08:00

1.9 KiB

Minima

A clean and minimal Hugo theme porting from Hexo Minima. Check out the example site.

screenshot

Note that the main branch is in development stage, UI or configuration may vary.

Features

  • Dark mode
  • Multilingual mode
  • Code highlighting - VSCode dark+
  • Math - KaTeX
  • Flowcharts - Mermaid
  • Comment - Disqus, Utterances, Giscus
  • Google analytics
  • External link
  • RSS

Usage

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

Installation

You can use either git submodule or git clone to fetch this theme into the directory where Hugo places themes.

Git Submodule

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

Git Clone

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

Configuration

Follow exampleSite/config.yaml and edit your own one.

Supported Front Matters

Attr Type Explanation
title string title
description string description
date string creation time
categories array category list
series array series list
tags array tag list
math bool enables math plugin
diagram bool enables diagram plugin
comment bool enable comment plugin
draft bool disallow being published
link string a URL to redirect to

Contribution

I'm currently looking for i18n contributors :)

Feedback

Feedbacks are welcome here.

License

Hugo Minima is MIT licensed.