blob: 7864821333b0f2bdc761d13b07340791f0396844 (
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
|
# hugo-theme-basic
Basic personal site theme styled with minimal tachyons.
## Features
- ✨ Basic — HTML with a dash of style + emojis stand out more
- 🌯 Extensible — Easily leverage [tachyons](https://tachyons.io/components/) to spice it up
- 🥑 Syntax Highlighting - When you get the urge to code
### Index
### Blog
### Post
## Getting started
### Installation
Run this command from the root of your Hugo directory (Git needs to be installed):
```
$ git clone https://github.com/siegerts/hugo-theme-basic.git
```
Or, if your Hugo site is already in git, you can include this repository as a git submodule. This makes it easier to update this theme. For this you need to run:
```
$ git submodule add https://github.com/siegerts/hugo-theme-basic.git themes/hugo-theme-basic
```
Alternatively, if you are not familiar with git, you can download the theme as a .zip file, unzip the theme contents, and then move the unzipped source into your themes directory.
For more information, read the official [documentation](https://gohugo.io/themes/installing-and-using-themes) of Hugo.
### Configuration
Take a look at the sample `config.toml`file located in the `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example configuration file, feel free to change strings as you like to customize your website.
#### Content Types
| Type | Description | Command |
| ----------- | --------------------------------------------------------------------------------- | ------------------------------------ |
| **Post** | Used for blog posts. Posts are listed on the `/blog` page. | `hugo new post/<post-name>.md` |
| **Page** | Used for site pages. | `hugo new page/<page-name>.md` |
| **Project** | Used for project pages. Extend project list with `/layouts/section/project.html`. | `hugo new project/<project-name>.md` |
#### Menu
Menu links are specified, in order, in the theme configuration.
For example:
```toml
[[params.menu]]
name = "blog"
url = "blog/"
[[params.menu]]
name = "about"
url = "page/about"
```
## Acknowledgments
- [tachyons](http://tachyons.io/)
## License
The code is available under the [MIT license](https://github.com/siegerts/hugo-theme-basic/blob/master/LICENSE).
|
