blob: 6c555aca10d8808f953517e4f418965b3241a392 (
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
|
# Hugo Theme Doors
Single page theme for links to your works.
See a real usage here: https://zzzmisa.com/
![Doors screenshot](https://github.com/zzzmisa/hugo-theme-doors/blob/master/images/screenshot.png?raw=true)
## Features
- Links to your works
- Responsive
- SNS button
- Google Analytics
- Accelerated Mobile Pages (AMP) supported
## Getting started
The example of how to use this theme is provided in the `exampleSite` folder. At first, try running the example site. The contents of the site can be configured by `config.toml`. After the example site appears, rewrite `config.toml` with your own data to make your own site.
## Run example site
1. Install [Hugo](https://gohugo.io/).
2. Create a new project folder to running the example site.
```
$ mkdir mySite
```
3. Install this theme into your project folder.
```
$ cd mySite
$ git clone https://github.com/zzzmisa/hugo-theme-doors.git themes/hugo-theme-doors
```
4. Copy the entire contents of the `exampleSite` to root folder of your project folder.
```
$ cp -r themes/hugo-theme-doors/exampleSite/* .
```
5. Test the example site.
```
$ hugo server -w
```
See the result at http://localhost:1313/ on your browser.
6. Build the example site.
```
$ hugo
```
Find result files in the `public` folder in the root of your project folder.
## Contributing
Bug reports and pull requests are welcome! By submitting a pull request, you agree to license your contribution under the MIT license.
## Supported Hugo versions
Hugo Theme Doors is tested against Hugo `v0.53` to `v0.92.0`.
## Attribution notices
Doors includes open source software and its modified versions. Attribution notices are in code comments of [index.html](https://github.com/zzzmisa/hugo-theme-doors/blob/master/layouts/index.html) and the build output file.
|