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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# Devise
A fast, minimal, and responsive [Hugo](https://gohugo.io/) theme for blogs.
![screenshot.png](https://raw.githubusercontent.com/austingebauer/devise/master/images/screenshot.png)
## Configuration Features
- General
- Hugo's Builtin [Content Management](https://gohugo.io/content-management/) Features
- Google Analytics
- Header
- Title and Subtitle
- Image
- Navigation Menu
- [Font Awesome](https://fontawesome.com/) Icons with Links
- Main Body
- Last 'N' Recent Pages
- Categorical Page Grouping
## Usage
This following guides installation, configuration, and updating of the Devise Hugo theme.
### Installation
Before installing this theme, be sure to [install Hugo](https://gohugo.io/getting-started/quick-start/)
and [create a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site).
To install the theme, run the following from the root directory of your Hugo site:
```bash
$ git submodule add https://github.com/austingebauer/devise.git themes/devise
```
### Configuration
Next, open the `config.toml` file in the root of your Hugo site and set the theme:
```toml
theme = "devise"
```
Example `config.toml` file with all configuration features filled out:
```toml
baseURL = "https://example.com"
title = "Your Website Title"
languageCode = "en-us"
theme = "devise"
relativeURLs = true
enableEmoji = true
googleAnalytics = ""
enableRobotsTXT = true
copyright = "© Copyright Year, Your Name"
# Main menu items
[menu]
[[menu.main]]
identifier = "about"
name = "About"
title = "About"
url = "/about/"
weight = -110
[[menu.main]]
identifier = "posts"
name = "Posts"
title = "Posts"
url = "/post/"
weight = -100
[[menu.main]]
identifier = "categories"
name = "Categories"
title = "Categories"
url = "/categories/"
weight = -90
# Configuration Features
[params]
header_title = "Your Name" # Your header title
header_subtitle = "Your Creative Subtitle" # Your header subtitle
home_image = "/images/avatar.png" # Path to header image starting from the static directory
recent_posts = 5 # Max amount of recent posts to show
mainSections = ["posts", "post", "blog"] # Main sections to include in recent posts
[[params.social]]
fa_icon = "fab fa-github fa-1x" # Font Awesome icon class
href = "http://github.com/youruser" # Link to associate with icon
[[params.social]]
fa_icon = "fab fa-linkedin-in fa-1x"
href = ""
[[params.social]]
fa_icon = "fab fa-twitter fa-1x"
href = ""
[[params.social]]
fa_icon = "fas fa-at fa-1x"
href = ""
```
### Updating
To get updates to the theme, run the following from the root directory of your Hugo site:
```
$ git submodule update --remote themes/devise
```
## Demo
To run a live demo of the theme, run the following from the `exampleSite` directory of the
devise theme:
```bash
hugo server --themesDir ../.. --watch --verbose --cleanDestinationDir --disableFastRender
```
This theme is also used on [Austin Gebauer's](https://github.com/austingebauer) personal website,
located at [austingebauer.com](https://austingebauer.com)
## Contributing
If you have an idea for a new feature or found a bug, please feel free to use Github
[issues](https://github.com/austingebauer/devise/issues) to let me know.
## License
[MIT](LICENSE)
|