mirror of
https://github.com/carsonip/hugo-theme-minos
synced 2025-12-30 03:19:49 -08:00
Update readme
This commit is contained in:
57
README.md
57
README.md
@@ -1,10 +1,35 @@
|
|||||||
# Minos
|
# Minos
|
||||||
|
|
||||||
Minos is a hugo theme ported from Hexo theme [Minos](https://github.com/ppoffice/hexo-theme-minos) by [@ppoffice](https://github.com/ppoffice/).
|
**_A simple and retro styled Hexo theme, concentrated more on your ideas._**
|
||||||
|
|
||||||
Work in progress.
|
Minos is a hugo theme ported from Hexo theme [Minos](https://github.com/ppoffice/hexo-theme-minos). Requires Hugo v0.15+.
|
||||||
|
|
||||||
## Site Params
|
## Features
|
||||||
|
|
||||||
|
* Everything in the original Mino theme, except
|
||||||
|
* Gallery (fancybox)
|
||||||
|
* Duoshuo comment
|
||||||
|
* Search box
|
||||||
|
* Disqus
|
||||||
|
* Google Analytics
|
||||||
|
* [KaTeX](https://github.com/Khan/KaTeX)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install Minos as your theme, first clone this repository in the `themes/` directory:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ cd themes/
|
||||||
|
$ git clone --depth 1 https://github.com/carsonip/hugo-theme-minos
|
||||||
|
```
|
||||||
|
|
||||||
|
Second, specify `hugo-theme-minos` as your default theme in the config.toml file. Just add the line
|
||||||
|
|
||||||
|
```
|
||||||
|
theme = "hugo-theme-minos"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
### Disqus
|
### Disqus
|
||||||
```
|
```
|
||||||
@@ -18,8 +43,32 @@ Work in progress.
|
|||||||
googleAnalytics = "UA-123-45"
|
googleAnalytics = "UA-123-45"
|
||||||
```
|
```
|
||||||
|
|
||||||
### [KaTeX](https://github.com/Khan/KaTeX)
|
### KaTeX
|
||||||
```
|
```
|
||||||
[params]
|
[params]
|
||||||
katex = true
|
katex = true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
1. Fork it!
|
||||||
|
2. Create your feature branch: `git checkout -b my-new-feature`
|
||||||
|
3. Commit your changes: `git commit -am 'Add some feature'`
|
||||||
|
4. Push to the branch: `git push origin my-new-feature`
|
||||||
|
5. Submit a pull request :D
|
||||||
|
|
||||||
|
## Original Author
|
||||||
|
|
||||||
|
PPOffice
|
||||||
|
|
||||||
|
* https://github.com/ppoffice
|
||||||
|
|
||||||
|
## Ported by
|
||||||
|
|
||||||
|
Carson Ip
|
||||||
|
|
||||||
|
* https://github.com/carsonip
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
|
||||||
Reference in New Issue
Block a user