From d0f303916fedafb70ad349d5c34512a8ff113237 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Wed, 7 Feb 2018 18:33:40 +0100 Subject: [PATCH] Add some showcase guide content Closes #322 --- content/showcase/template/index.md | 83 ++++++++---------------------- 1 file changed, 21 insertions(+), 62 deletions(-) diff --git a/content/showcase/template/index.md b/content/showcase/template/index.md index 27899b5e8..681504e87 100644 --- a/content/showcase/template/index.md +++ b/content/showcase/template/index.md @@ -1,11 +1,13 @@ --- # A suitable title for this article. -title: Example Hugo Site +title: Hugo Showcase Template # Set this to the current date. date: 2018-02-07 +description: "A short description of this page." + # The URL to the site on the internet. siteURL: https://gohugo.io/ @@ -18,73 +20,30 @@ byline: "[bep](https://github.com/bep), Hugo Lead" --- +Have a **notable Hugo site[^1]**? We would love to feature it in this **Showcase Section** -If you want your Hugo site to be featured in the **Showcase Section**, we would appreciate if you followed the guidelines outlined below. +We would really appreciate if you could: -In general: - -* Create a copy of ... -* Adjust front matter meta data and write a story about your site -* Open a PR in https://github.com/gohugoio/hugoDocs/pulls - - -We want this to show Hugo in its best light, so **it must be notable to be considered.** So not the average Hugo blog; it needs to tell a story or the site owner must be notable... +1. Fork https://github.com/gohugoio/hugoDocs and create a branch +1. Create a copy of the `content/showcase/template` directory with a suitable name. If you now run `hugo server`, your site should show up in [http://localhost:1313/showcase/](http://localhost:1313/showcase/) and on the front page. +2. Adjust the [files](#files) and write a story about your site +3. Create a new pull request in https://github.com/gohugoio/hugoDocs/pulls +**Note:** The Showcase section uses the latest bells and whistles from Hugo, [resources](/content-management/page-resources/) with [image processing](/content-management/image-processing/), so you need a reasonable up-to-date [Hugo version](https://github.com/gohugoio/hugo/releases). ## Files -The simplest +The content of the `content/showcase/template` directory 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-template.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). -Lorem markdownum signum. Mille *deus* erat fecundique et germana angues *manum -movente in* talis Iuno licet lentae fundamine stare pulcherrime. Flammae nigra -aquilonibus sunt nisi mirum modo ad saxa hostem conclamat admovet. Mandataque -horret possis magis prius simulatoremque pervia tum, liquefacta? Veteris -[praetenta ipsa venit](http://armis-forte.io/carmine) turis esse vobis: tura -quidem quia. -- Terra quo natus conpleat moras -- Parte loca eloquioque consensu iungit sospite nominis -- Quoque contraxit motaeque -- Vada viae ne terrae corporis illis ego -- Novique inplevit - -## Iungi ab obscura mora novem culpavi pulcherrima - -Vicinaque simulacra materna, antro Combe et monuit suo postera undis. Placeat -unda segetes fit sedibus taedae habeo. - -**Omnes vacat** sentit. Vota agebat, arbore Antiphates *vitam vivere* sinistra -parili diripuit volantes rapiunt; miratur habentia nymphae. - -## Cum sui dicta talis utrumque aut arbusta - -Tantum argenteus adhuc, nec numen saxo petendi dicentem, promissaque vocant -corripuere quoque: Nesso ita? Lapidosas balistave rigidas: quascumque delubra -amor est. - -## Corpora aberat - -Videt vidit vidisti crepuitque natus regnat **notam** arenti in lata. Certa -intra factus vestis, mansit dedit sociare imitetur illos dixerunt ponunt -valerem. Et tenuit, pars cum Laurentes avidum fissaque revocataque omnes ignibus -nescio rector? - -## Hos ponti adhuc maius cui mortalia erat - -Relinquo hanc. Femina **oris**, virgo, displicet debilitaturum repressit amnes -nec mutavit ortus, tollens recuset nivea propiore tum? - -1. Ubi unda cum -2. Fuga in enim nostri incognita Aesonis petit -3. Formamque locus virtus habebat flumina robustior ira -4. Collumque rabie ardua -5. Veni arte Cycni Anubis dextrae coniunx est -6. Inmitibus futuri et grave tricuspide paranti - -Furtum dolor est mando inhospita toris dentibus et laborem notitiam in solus -armandique. Luet nusquam modo, locumque iuga suos pars via releguntque mundi -boumque: me **inpune oris quoque**. Quod furor: illos libet suarum fecere -pectore salignis ficta sacros alta agros monet incipere. Eundem patet quorum si -totidemque stridet momentaque undas petii inquit. Vulgata iniusta, *nomine*, in -campos laetabere et verba sine orantem. \ No newline at end of file +[^1]: We want this to show Hugo in its best light, so this is not for the average Hugo blog. In most case the answer to "Is my site [notabable](http://www.dictionary.com/browse/notable)?" will be obvious, but if in doubt, create and [issue](https://github.com/gohugoio/hugoDocs/issues) with a link and some words, and we can discuss it. But if you have a site with an interesting Hugo story or a company site where the company itself is notable, you are most welcome.