TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-19 10:35:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update docs contrib guide

Browse Source
This commit is contained in:
Ryan Watters 2017-03-10 03:19:27 -06:00
parent df5eb4e732
commit cc0d8203f6
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
archetypes/showcase.md
View File

@ -7,7 +7,7 @@ sitelink: ""
sourcelink: ""
categories: [showcase]
tags: []
image: "yourimage.jpg"
image: ""
toc: false
z_notesforauthors: "Go to gohugo.io/contribute/documentation for more info on using this archetype."
notesforauthors: "Go to gohugo.io/contribute/documentation for more info"
---

2
archetypes/tutorials.md
View File

@ -11,6 +11,6 @@ authorurl: ""
originalurl: ""
draft: false
aliases: []
z_notesforauthors: "Go to gohugo.io/contribute/documentation for more info on using this archetype."
notesforauthors: "Go to gohugo.io/contribute/documentation for more info."
---

10
content/contribute/documentation.md
View File

@ -109,23 +109,23 @@ The archetype for the `showcase` content type is as follows:
#### Showcase Required Fields
`sitelink`
***`sitelink`***
: the *full* URL to your website.
`title`
***`title`***
: the `<title>` of your website.
`description`
***`description`***
: a general description of your website, preferably < 180 characters.
`image`
***`image`***
: the image (filename only) you want to associate with your website on the Showcase page. The image should be 450px &times; 300px.
We also appreciate the addition of the remaining fields, especially `sourcelink` and `license` if you are willing to share your hard work with the open-source community. `tags` is optional, but we recommend adding at least 2 to 3 tags to improve discoverability.
#### Add an Image for the Showcase
We need to create the thumbnail of your website. Give your thumbnail a name like `my-hugo-site-name.jpg`. Save it under [`docs/static/images/showcase/`][].
Youl will need to create a thumbnail of your website. Give your thumbnail a name like `my-hugo-site-name.jpg`. Save it under [`docs/static/images/showcase/`][].
{{% warning "Showcase Image Size" %}}
It's important that the image you use for your showcase submission has the required dimensions of 450px &times; 300px or the site will not render appropriately. Be sure to optimize your image as a matter of best practice. [Compressor](https://compressor.io/) offers a simple drag-and-drop GUI for optimizing your images. JPEGs are typically smaller in size than are PNGs.