hugo-theme-minima/README.md

# Minima

A clean and minimal Hugo theme porting 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 stage, 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] 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.
Initial commit 2021-07-18 10:34:01 +02:00			`# Minima`

update readme 2022-11-08 17:05:50 +01:00			`A clean and minimal Hugo theme porting from [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). Check out the [example site](https://mivinci.github.io/hugo-theme-minima).`
Initial commit 2021-07-18 10:34:01 +02:00
README 2021-07-18 15:40:40 +02:00			`![screenshot](./images/tn.png)`

update readme 2022-11-08 17:05:50 +01:00			`> Note that the main branch is in development stage, UI or configuration may vary.`


Initial commit 2021-07-18 10:34:01 +02:00			`## Features`

update readme and screenshots 2022-11-08 16:53:16 +01:00			`- [x] Dark mode`
			`- [x] Multilingual mode`
			`- [x] Code highlighting - VSCode dark+`
			`- [x] Math - KaTeX`
			`- [x] Flowcharts - Mermaid`
			`- [x] Comment - Disqus, Utterances, Giscus`
README 2021-07-18 15:40:40 +02:00			`- [x] Google analytics`
update readme and screenshots 2022-11-08 16:53:16 +01:00			`- [x] External link`
docs 2022-02-17 12:55:29 +01:00			`- [x] RSS`
Initial commit 2021-07-18 10:34:01 +02:00
			`## Usage`

update introduction 2021-11-12 09:30:39 +01:00			`Before using Minima, make sure you've got Hugo (extended version) installed on your device.`
README 2021-07-18 15:40:40 +02:00
			`### Installation`

update readme and screenshots 2022-11-08 16:53:16 +01:00			You can use either `git submodule` or `git clone` to fetch this theme into the directory where Hugo places themes.

			`#### Git Submodule`
README 2021-07-18 15:40:40 +02:00
			```bash
			`git submodule add --depth 1 https://github.com/mivinci/hugo-theme-minima.git themes/minima`
			```

update readme and screenshots 2022-11-08 16:53:16 +01:00			`#### Git Clone`
README 2021-07-18 15:40:40 +02:00
			```bash
			`git clone https://github.com/mivinci/hugo-theme-minima.git themes/minima`
			```


			`### Configuration`

Create README.md 2022-11-08 19:11:37 +01:00			`Follow [exampleSite/config.yaml](https://github.com/Mivinci/hugo-theme-minima/blob/main/exampleSite/config.yaml) and edit your own one.`
README 2021-07-18 15:40:40 +02:00
update readme 2022-11-08 17:05:50 +01:00			`## Supported Front Matters`
README 2021-07-18 15:40:40 +02:00
update readme 2022-11-08 17:05:50 +01:00			`\| 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 \|`
standarize configuration 2022-11-09 13:51:50 +01:00			`\| math \| bool \| enables math plugin \|`
			`\| diagram \| bool \| enables diagram plugin \|`
update readme 2022-11-08 17:05:50 +01:00			`\| comment \| bool \| enable comment plugin \|`
			`\| draft \| bool \| disallow being published \|`
			`\| link \| string \| a URL to redirect to \|`
new feature: external link post 2022-01-30 08:12:29 +01:00

update readme 2022-11-08 17:05:50 +01:00			`## Contribution`
docs 2022-02-17 12:55:29 +01:00
update readme and screenshots 2022-11-08 16:53:16 +01:00			`I'm currently looking for i18n contributors :)`
new feature: external link post 2022-01-30 08:12:29 +01:00
update readme 2022-11-08 17:05:50 +01:00			`## Feedback`
README 2021-07-18 15:40:40 +02:00
			`Feedbacks are welcome [here](https://github.com/Mivinci/hugo-theme-minima/issues).`
update readme 2022-11-08 17:05:50 +01:00
add a star history chart 2023-03-01 19:38:59 +01:00			`## 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)`

update readme 2022-11-08 17:05:50 +01:00			`## License`

			`Hugo Minima is MIT licensed.`