hugo-theme-even/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2017-08-27 14:38:42 +00:00
# hugo-theme-even
2017-08-31 15:14:25 +00:00
A super concise theme for Hugo
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
> It's a port of the [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
[Demo](https://blog.olowolo.com/example-site/) | [中文说明](https://github.com/olOwOlo/hugo-theme-even/blob/master/README-zh.md)
2017-08-27 14:38:42 +00:00
## Screenshots
![even-showcase](https://raw.githubusercontent.com/olOwOlo/hugo-theme-even/master/images/showcase.png)
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
## Feature
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
- Responsive
- Fancybox
- Config license for content
- highlight.js
- Custom theme color
- mathjax
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
## Installation
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
```bash
$ git clone https://github.com/olOwOlo/hugo-theme-even themes/even
2017-08-27 14:38:42 +00:00
```
**Important:** Take a look inside the [`exampleSite`](https://github.com/olOwOlo/hugo-theme-even/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml). **To use it, copy the [`config.toml`](https://github.com/olOwOlo/hugo-theme-even/blob/master/exampleSite/config.toml) in the root folder of your Hugo site.** Feel free to change it.
2017-08-27 14:38:42 +00:00
## Configuration
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
- **favicon.ico:** Just put your favicon.ico under the `/static` directory if you want to change the default favicon.ico.
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
- **Front matter:** Copy the `default.md` file from the `archetypes` directory to your `archetypes`.
2017-08-27 14:38:42 +00:00
- **Language:** Language files are under [`/themes/even/data/even/`](https://github.com/olOwOlo/hugo-theme-even/tree/master/data/even) directory. Create a new directory `even` under your `data` directory and copy the `default.toml` to your `/data/even/`, and then you can change it if you want.
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
- **Theme color:** Default | Mint Green | Cobalt Blue | Hot Pink | Dark Violet
2017-08-27 14:38:42 +00:00
You can config it by changing the `$theme-color-config` value in `/src/css/_variable.scss`.
2017-08-27 14:38:42 +00:00
### Build
2017-08-31 15:14:25 +00:00
if you change any file under `/src/`, you need to rebuild.
2017-08-27 14:38:42 +00:00
```bash
cd ./themes/even/src/
npm install
npm run build
2017-08-27 14:38:42 +00:00
```
## License
2017-08-31 15:14:25 +00:00
Released under the [MIT](https://github.com/olOwOlo/hugo-theme-even/blob/master/LICENSE.md) License.
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
## Acknowledgements
2017-08-27 14:38:42 +00:00
2017-08-31 15:14:25 +00:00
- [ananke](https://github.com/budparr/gohugo-theme-ananke)
- [hexo-theme-even](https://github.com/ahonn/hexo-theme-even)
- [hugo-nuo](https://github.com/laozhu/hugo-nuo)