Skip to content

Commit

Permalink
Add showcase archetype folder
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Sep 24, 2018
1 parent 7c9df47 commit 73dcd02
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 29 deletions.
8 changes: 8 additions & 0 deletions archetypes/showcase/bio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

Add some **general info** about {{ replace .Name "-" " " | title }} here.

The site is built by:

* [Person 1](https://example.com)
* [Person 1](https://example.com)

Binary file added archetypes/showcase/featured.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions archetypes/showcase/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---

title: {{ replace .Name "-" " " | title }}
date: {{ now.Format "2006-01-02" }}

description: "A short description of this page."

# The URL to the site on the internet.
siteURL: https://gohugo.io/

# Link to the site's Hugo source code if public and you can/want to share.
# Remove or leave blank if not needed/wanted.
siteSource: https://github.com/gohugoio/hugoDocs

# Add credit to the article author. Leave blank or remove if not needed/wanted.
byline: "[bep](https://github.com/bep), Hugo Lead"

---

To complete this showcase:

1. Write the story about your site in this file.
2. Add a summary to the `bio.md` file in this folder.
3. Replace the `featured-template.png` with a screenshot of your site. You can rename it, but it must contain the word `featured`.
4. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls

The content of this bundle explained:

index.md
: 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.

bio.md
: A short summary of the website. Site credits (who built it) fits nicely here.

featured.png
: 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).

31 changes: 2 additions & 29 deletions content/en/showcase/template/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,10 @@
---

# A suitable title for this article.
title: Hugo Showcase Template

# Set this to the current date.
date: 2018-02-07

description: "A short description of this page."

# The URL to the site on the internet.
siteURL: https://gohugo.io/

# Link to the site's Hugo source code if public and you can/want to share.
# Remove or leave blank if not needed/wanted.
siteSource: https://github.com/gohugoio/hugoDocs

# Add credit to the article author. Leave blank or remove if not needed/wanted.
byline: "[bep](https://github.com/bep), Hugo Lead"

---
Expand All @@ -25,25 +14,9 @@ Have a **notable Hugo site[^1]**? We would love to feature it in this **Showcase
We would really appreciate if you could:

1. Fork https://github.com/gohugoio/hugoDocs
1. Create a copy of the [content/showcase/template](https://github.com/gohugoio/hugoDocs/tree/master/content/showcase/template) directory with a suitable name. If you now run `hugo server`, your site should show up in [http://localhost:1313/showcase/](http://localhost:1313/showcase/) and on the front page.
2. Adjust the [files](#files) and write a story about your site
2. Run `hugo new showcase/your-site` (this requires >= Hugo 0.49). This will use the archetype bundle in the [docs repo](https://github.com/gohugoio/hugoDocs/tree/master/archetypes).
3. Follow the instructions in the newly created page bundle.
3. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls

**Note:** The Showcase section uses the latest bells and whistles from Hugo, [resources](/content-management/page-resources/) with [image processing](/content-management/image-processing/), so you need a reasonable up-to-date [Hugo version](https://github.com/gohugoio/hugo/releases).

## Files

The content of the [content/showcase/template](https://github.com/gohugoio/hugoDocs/tree/master/content/showcase/template) directory explained:

index.md
: 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.

bio.md
: A short summary of the website. Site credits (who built it) fits nicely here.

featured-template.png
: 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).



[^1]: We want this to show Hugo in its best light, so this is not for the average Hugo blog. In most cases the answer to "Is my site [notabable](http://www.dictionary.com/browse/notable)?" will be obvious, but if in doubt, create an [issue](https://github.com/gohugoio/hugoDocs/issues) with a link and some words, and we can discuss it. But if you have a site with an interesting Hugo story or a company site where the company itself is notable, you are most welcome.

0 comments on commit 73dcd02

Please sign in to comment.