blob: eb2d37e4de8bd502fba204228d0b2062a374c5d7 (
plain) (
blame)
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
|
+++
title = "Puppet - Getting Started"
date = 2022-08-09T15:38:30+08:00
header_img = ""
toc = true
tags = ["documentation", "guide"]
categories = []
series = ["Themes Guide"]
+++
Puppet is a responsive, simple and clean [Hugo](https://gohugo.io/) theme based on the [Huxblog Jekyll theme](https://github.com/Huxpro/huxpro.github.io).
<!--more-->
## Install Hugo
Make sure you have installed the lastest version of [Hugo-extented](https://gohugo.io/getting-started/installing/).
## Create a New Site
```
hugo new site mysite
```
## Add the Theme
You can download and unpack the theme manually from Github or use git to clone the theme into your site's `themes` directory.
```bash
cd mysite
git init
git clone https://github.com/roninro/hugo-theme-puppet.git themes/puppet
```
Or you can add the theme as a submodule.
```bash
cd mysite
git init
git submodule add https://github.com/roninro/hugo-theme-puppet.git themes/puppet
git submodule update --init --recursive
```
That’s all, Puppet is ready to be used.
## Add Config Files
For getting started, you can copy the `config.toml` file from the theme's exampleSite directory to the root directory of your site.
```bash
cp themes/puppet/exampleSite/config.toml .
```
> Note: You may need to delete the `themesDir` line in the config file.
## Add Some Content
Create a new post with the following command.
```bash
hugo new posts/my-first-post.md
```
Edit the content of the post.
```markdown
+++
title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }}
description = ""
draft = true
subtitle = ""
header_img = ""
toc = true
tags = []
categories = []
series = []
comment = true
+++
Your content here...
```
Some front-matter used for SEO, others used for displaying contents, configuration, etc.
## Run example site
From the root of themes/puppet/exampleSite:
```bash
hugo server --themesDir ../..
```
|
