https://github.com/mivinci/hugo-theme-minima

A clean and minimal Hugo theme.
https://github.com/mivinci/hugo-theme-minima

hugo hugo-blog-theme hugo-theme minima

Last synced: 6 days ago
JSON representation

A clean and minimal Hugo theme.

• Host: GitHub
• URL: https://github.com/mivinci/hugo-theme-minima
• Owner: mivinci
• License: mit
• Created: 2021-07-18T08:06:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-27T05:51:23.000Z (about 1 month ago)
• Last Synced: 2025-01-17T20:08:17.969Z (13 days ago)
• Topics: hugo, hugo-blog-theme, hugo-theme, minima
• Language: HTML
• Homepage: https://mivinci.github.io/hugo-theme-minima
• Size: 2.53 MB
• Stars: 139
• Watchers: 3
• Forks: 37
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minima

Minima is a clean and minimal Hugo theme originally ported from [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). Check out the [example site](https://mivinci.github.io/hugo-theme-minima).

![screenshot](./images/tn.png)

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

## Features

- [x] 🌗 Dark mode

- [x] 📚 Multilingual mode

- [x] 🏳️‍🌈 Code highlighting - VSCode dark+

- [x] 🔢 Math - KaTeX

- [x] 💹 Flowcharts - Mermaid

- [x] 🧑‍💻 Comment - Disqus, Utterances, Giscus

- [x] 🔎 Search - FuseJS

- [x] 〽️ Google analytics

- [x] 🔗 External link

- [x] ✉️ 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

```bash

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

```

#### Git Clone

```bash

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

```

### Configuration

Follow [exampleSite/config.yaml](https://github.com/Mivinci/hugo-theme-minima/blob/main/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](https://github.com/Mivinci/hugo-theme-minima/issues).

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=mivinci/hugo-theme-minima&type=Date)](https://star-history.com/#star-history/star-history&Date)

## License

Hugo Minima is MIT licensed.