tiennm99/hugoDocs
1
0 Fork 0
mirror of https://github.com/tiennm99/hugoDocs.git synced 2026-10-13 22:16:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs contrib guide

Browse Source
This commit is contained in:
Ryan Watters committed 2017-03-10 03:19:27 -06:00
1 parent df5eb4e732
commit cc0d8203f6
3 files changed
+8 -8
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

archetypes/showcase.md
+2 -2
View File
@@ -7,7 +7,7 @@ sitelink: ""
sourcelink: "" sourcelink: ""
categories: [showcase] categories: [showcase]
tags: [] tags: []
image: "yourimage.jpg" image: ""
toc: false 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"
--- ---
archetypes/tutorials.md
+1 -1
View File
@@ -11,6 +11,6 @@ authorurl: ""
originalurl: "" originalurl: ""
draft: false draft: false
aliases: [] 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."
--- ---
content/contribute/documentation.md
+5 -5
View File
@@ -109,23 +109,23 @@ The archetype for the `showcase` content type is as follows:
#### Showcase Required Fields #### Showcase Required Fields
`sitelink` ***`sitelink`***
: the *full* URL to your website. : the *full* URL to your website.
`title` ***`title`***
: the `<title>` of your website. : the `<title>` of your website.
`description` ***`description`***
: a general description of your website, preferably < 180 characters. : 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. : 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. 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 #### 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" %}} {{% 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. 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.