blob: a2f883e32e322909dc37def542ddfa75836923b0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
# m10c theme
A Hugo minimalistic theme for bloggers
Main features:
- Fully responsive
- Twitter Cards, Open Graph, Disqus and Google Analytics supported (see Hugo docs)
- Customizable colors
- Customizable picture and description
- Customizable menu on sidebar
- Customizable social media links on sidebar
- Optimized for performance 100/100 on Lighthouse
- All feather icons included
## Getting started
### Installation
Create a new Hugo site:
```bash
$ hugo new site [path]
```
Clone this repository into `themes/` directory:
```bash
$ cd [path]
$ git clone https://github.com/vaga/hugo-theme-m10c.git themes/m10c
```
Add this line in the `config.toml` file:
```toml
theme = "m10c"
```
### Configuration
In your `config.toml` file, define the following variables in `params`:
- `author`: Name of the author
- `description`: Short description of the author
- `avatar`: Path of file containing the author avatar image
- `menu_item_separator`: Separator between each menu item. HTML allowed (default: " - ")
- `favicon`: Absolute path of your favicon.ico file (default: "/favicon.ico")
To add a menu item, add the following lines in `menu`:
```
[[menu.main]]
identifier = "tags"
name = "Tags"
url = "/tags/"
```
[Read Hugo documentations](https://gohugo.io/content-management/menus/#readout) for more informations about menu
To add a social link, add the following lines in `params`:
```
[[params.social]]
icon = "github"
name = "My Github"
url = "https://github.com/vaga"
```
To change theme colors, add the following lines in `params`:
```
[params.style]
darkestColor = "#d35050"
darkColor = "#212121"
lightColor = "#f5e3e0"
lightestColor = "#f5f5f5"
primaryColor = "#ffffff"
```
If you want the above theme colors, you can see the [exampleSite/config.toml](/exampleSite/config.toml) file.
### Styling
To override styles using scss, add a file called `_extra.scss` to `[path]/assets/css/`
**Note:** Hugo releases come in two versions, `hugo` and `hugo_extended`. You need `hugo_extended` to automatically compile your scss.
## License
This theme is released under the [**MIT**](/LICENSE.md) License.
## Acknowledgements
- [feather](https://feathericons.com/) - [MIT](https://github.com/feathericons/feather/blob/master/LICENSE)
|
