summaryrefslogtreecommitdiffstats
path: root/docs/archetypes
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2024-01-27 10:48:33 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2024-01-27 10:48:57 +0100
commit5fd1e7490305570872d3899f5edda950903c5213 (patch)
treef0cdc490a0942d720494c0044a64c6397d1ab6a5 /docs/archetypes
parentfc7de7136acbcf0aef54ae8460c7702bc83709be (diff)
parent9b0050e9aabe4be65c78ccf292a348f309d50ccd (diff)
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
Diffstat (limited to 'docs/archetypes')
-rw-r--r--docs/archetypes/functions.md11
-rw-r--r--docs/archetypes/methods.md10
-rw-r--r--docs/archetypes/news/index.md5
-rw-r--r--docs/archetypes/showcase/bio.md7
-rw-r--r--docs/archetypes/showcase/featured.pngbin0 -> 41270 bytes
-rw-r--r--docs/archetypes/showcase/index.md36
6 files changed, 69 insertions, 0 deletions
diff --git a/docs/archetypes/functions.md b/docs/archetypes/functions.md
new file mode 100644
index 000000000..44a2a5635
--- /dev/null
+++ b/docs/archetypes/functions.md
@@ -0,0 +1,11 @@
+---
+title: {{ replace .File.ContentBaseName "-" " " | title }}
+description:
+categories: []
+keywords: []
+action:
+ aliases: []
+ related: []
+ returnType:
+ signatures: []
+---
diff --git a/docs/archetypes/methods.md b/docs/archetypes/methods.md
new file mode 100644
index 000000000..2c415547d
--- /dev/null
+++ b/docs/archetypes/methods.md
@@ -0,0 +1,10 @@
+---
+title: {{ replace .File.ContentBaseName "-" " " | title }}
+description:
+categories: []
+keywords: []
+action:
+ related: []
+ returnType:
+ signatures: []
+---
diff --git a/docs/archetypes/news/index.md b/docs/archetypes/news/index.md
new file mode 100644
index 000000000..fcc5b5835
--- /dev/null
+++ b/docs/archetypes/news/index.md
@@ -0,0 +1,5 @@
+---
+title: {{ replace .File.ContentBaseName "-" " " | title }}
+description:
+date: {{ .Date }}
+---
diff --git a/docs/archetypes/showcase/bio.md b/docs/archetypes/showcase/bio.md
new file mode 100644
index 000000000..5d1708978
--- /dev/null
+++ b/docs/archetypes/showcase/bio.md
@@ -0,0 +1,7 @@
+
+Add some **general info** about {{ replace .Name "-" " " | title }} here.
+
+The site is built by:
+
+* [Person 1](https://example.org)
+* [Person 1](https://example.org)
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..04d454575
--- /dev/null
+++ b/docs/archetypes/showcase/index.md
@@ -0,0 +1,36 @@
+---
+
+title: {{ replace .File.ContentBaseName "-" " " | 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).