summaryrefslogtreecommitdiffstats
path: root/docs/archetypes
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-10-21 10:22:28 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-10-21 10:22:28 +0200
commit27aef3f1fbf657137e825f30bb50dda393618a6f (patch)
treebcc05254f2977e3cc75d7dcb4cbaac5625cf7a1b /docs/archetypes
parent39121de4d991bdcf5f202da4d8d81a8ac6c149fc (diff)
parentb9bd35d72e14932fb6588ff62b90cddef0a060fc (diff)
Diffstat (limited to 'docs/archetypes')
-rw-r--r--docs/archetypes/default.md13
-rw-r--r--docs/archetypes/functions.md17
-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
5 files changed, 75 insertions, 0 deletions
diff --git a/docs/archetypes/default.md b/docs/archetypes/default.md
new file mode 100644
index 000000000..f30f01f74
--- /dev/null
+++ b/docs/archetypes/default.md
@@ -0,0 +1,13 @@
+---
+linktitle: ""
+description: ""
+godocref: ""
+publishdate: ""
+lastmod: ""
+categories: []
+tags: []
+weight: 00
+slug: ""
+aliases: []
+toc: false
+--- \ No newline at end of file
diff --git a/docs/archetypes/functions.md b/docs/archetypes/functions.md
new file mode 100644
index 000000000..0a5dd344f
--- /dev/null
+++ b/docs/archetypes/functions.md
@@ -0,0 +1,17 @@
+---
+linktitle: ""
+description: ""
+godocref: ""
+publishdate: ""
+lastmod: ""
+categories: [functions]
+tags: []
+ns: ""
+signature: []
+workson: []
+hugoversion: ""
+aliases: []
+relatedfuncs: []
+toc: false
+deprecated: false
+--- \ No newline at end of file
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).
+