blob: 07a282536fbcfa1b428c8b5351b9877f0e157d40 (
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
|
# Crab
Crab is a clean website theme for the [Hugo](https://gohugo.io) static
site generator.
## Features
- responsive
- nested menus
- two-column
## Preview
If you'd like to get a live demo of the Crab theme locally, you could
clone the repository, cd to the `exampleSite` directory and run
`HUGO_THEMESDIR=../.. hugo serve -t crab` from there (assuming
[Hugo](http://gohugo.io) is already installed).
## Installation
Read the [Hugo Quickstart
Guide](https://gohugo.io/overview/quickstart/) for an introduction to
Hugo itself. Once you created a new Hugo site, you can use the Crab
theme.
In your Hugo site's folder:
```sh
$ git clone https://github.com/thomasheller/crab themes/crab
```
Alternatively, if your site is in a git repository, you can use git
submodules:
```sh
$ git submodule add https://github.com/thomasheller/crab themes/crab
```
To update the theme to the latest version, simply pull in the changes:
```sh
$ git -C themes/crab pull
```
## Usage
The file `exampleSite/config.toml` provides an example for how the
Crab theme can be configured, especially in regard to the menu items.
Once you put a `config.toml` in your site's root directory, you can
get a preview of your Hugo site as usual:
```sh
$ hugo serve -t crab
```
## Menus
See the `exampleSite/config.toml` file for how the menus can be
configured:
- Use the `weight` attribute to specify the order of menu items.
Menu items with smaller numbers appear before those with bigger
numbers.
- For every menu, specify an `identifier` if you intend the menu to
have sub-items. In each sub-item, make sure the `parent` attribute
matches the value of the `identifier` used for the parent menu.
- Choose a unique `name` for each item in the same menu.
## Two-column layout
Look at the `exampleSite/content/home.md` file for a sidebar example.
If you put a shortcode like this at the beginning of your content
file, the summary will appear in the right column:
```md
{{% summary %}}
This appears in the sidebar. *Markdown* is supported!
{{% /summary %}}
```
## Contact
If you think anything could be improved about the Crab theme, feel
free to [send a PR](https://github.com/thomasheller/crab) to the Crab
repository.
|
