index.md (1358B)
1 ---
2
3 title: {{ replace .Name "-" " " | title }}
4 date: {{ now.Format "2006-01-02" }}
5
6 description: "A short description of this page."
7
8 # The URL to the site on the internet.
9 siteURL: https://gohugo.io/
10
11 # Link to the site's Hugo source code if public and you can/want to share.
12 # Remove or leave blank if not needed/wanted.
13 siteSource: https://github.com/gohugoio/hugoDocs
14
15 # Add credit to the article author. Leave blank or remove if not needed/wanted.
16 byline: "[bep](https://github.com/bep), Hugo Lead"
17
18 ---
19
20 To complete this showcase:
21
22 1. Write the story about your site in this file.
23 2. Add a summary to the `bio.md` file in this folder.
24 3. Replace the `featured-template.png` with a screenshot of your site. You can rename it, but it must contain the word `featured`.
25 4. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls
26
27 The content of this bundle explained:
28
29 index.md
30 : The main content file. Fill in required front matter metadata and write your story. I does not have to be a novel. It can even be self-promotional, but it should include Hugo in some form.
31
32 bio.md
33 : A short summary of the website. Site credits (who built it) fits nicely here.
34
35 featured.png
36 : A reasonably sized screenshot of your website. It can be named anything, but the name must start with "featured". The sample image is `1500x750` (2:1 aspect ratio).
37