summaryrefslogtreecommitdiffstats
path: root/docs/archetypes
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-10-29 09:23:25 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-10-29 09:23:25 +0100
commit4b2738d87108ac7254b5e18ba842edb838affff4 (patch)
tree3fcc240051335eb890eb0ec838d71943b12b7eae /docs/archetypes
parent9c88a8a55adf7779039504fa77d74ec80d658c40 (diff)
parent74309fe5699a595080fdb3a14711e0869babce99 (diff)
Diffstat (limited to 'docs/archetypes')
-rw-r--r--docs/archetypes/showcase/bio.md8
-rw-r--r--docs/archetypes/showcase/featured.pngbin0 -> 41270 bytes
-rw-r--r--docs/archetypes/showcase/index.md37
3 files changed, 45 insertions, 0 deletions
diff --git a/docs/archetypes/showcase/bio.md b/docs/archetypes/showcase/bio.md
new file mode 100644
index 000000000..2443c2f35
--- /dev/null
+++ b/docs/archetypes/showcase/bio.md
@@ -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)
+
diff --git a/docs/archetypes/showcase/featured.png b/docs/archetypes/showcase/featured.png
new file mode 100644
index 000000000..4f390132e
--- /dev/null
+++ b/docs/archetypes/showcase/featured.png
Binary files differ
diff --git a/docs/archetypes/showcase/index.md b/docs/archetypes/showcase/index.md
new file mode 100644
index 000000000..a21bb9726
--- /dev/null
+++ b/docs/archetypes/showcase/index.md
@@ -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).
+