From e4440a1848c1780a45b8ff0508a1d9154c4665a7 Mon Sep 17 00:00:00 2001 From: Jhaura Wachsman Date: Wed, 3 Jun 2020 18:34:16 +0000 Subject: [PATCH] Project and Content Cleanup, Normalization (#61) --- README.md | 7 +++++++ config.toml | 2 -- configTaxo.toml | 29 ++++++++++++++--------------- content/_index.md | 1 - content/about.md | 7 ++----- content/archives.md | 2 +- content/homepage/about.md | 2 +- content/homepage/index.md | 2 +- content/homepage/work.md | 2 +- content/post/_index.md | 2 +- content/post/emoji-support.md | 17 ++++++++--------- content/post/markdown-syntax.md | 26 ++++++++++++-------------- content/post/math-typesetting.md | 10 ++++++---- content/post/placeholder-text.md | 25 ++++++------------------- 14 files changed, 60 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index aa38bb6e..11a456ca 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,24 @@ This repository offers an example site for [Hugo](https://gohugo.io/) and also i 1. [Install Hugo](https://gohugo.io/overview/installing/) 2. Clone this repository + ```bash git clone https://github.com/gohugoio/hugoBasicExample.git cd hugoBasicExample ``` + 3. Clone the repository you want to test. If you want to test all Hugo Themes then follow the instructions provided [here](https://github.com/gohugoio/hugoThemes#installing-all-themes) + 4. Run Hugo and select the theme of your choosing + ```bash hugo server -t YOURTHEME ``` + 5. Under `/content/` this repository contains the following: + - A section called `/post/` with sample markdown content - A headless bundle called `homepage` that you may want to use for single page applications. You can find instructions about headless bundles over [here](https://gohugo.io/content-management/page-bundles/#headless-bundle) - An `about.md` that is intended to provide the `/about/` page for a theme demo + 6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) respository diff --git a/config.toml b/config.toml index 2e2dfb97..2f4a9e86 100644 --- a/config.toml +++ b/config.toml @@ -6,7 +6,6 @@ paginate = 3 languageCode = "en" DefaultContentLanguage = "en" enableInlineShortcodes = true -footnoteReturnLinkContents = "^" [menu] @@ -47,4 +46,3 @@ series = "series" [services.twitter] disableInlineCSS = true - diff --git a/configTaxo.toml b/configTaxo.toml index a6acc927..9220fcf6 100644 --- a/configTaxo.toml +++ b/configTaxo.toml @@ -1,6 +1,5 @@ timeout = 30000 enableInlineShortcodes = true -footnoteReturnLinkContents = "^" [taxonomies] category = "categories" @@ -9,20 +8,20 @@ series = "series" [privacy] -[privacy.vimeo] -disabled = false -simple = true + [privacy.vimeo] + disabled = false + simple = true -[privacy.twitter] -disabled = false -enableDNT = true -simple = true -disableInlineCSS = true + [privacy.twitter] + disabled = false + enableDNT = true + simple = true + disableInlineCSS = true -[privacy.instagram] -disabled = false -simple = true + [privacy.instagram] + disabled = false + simple = true -[privacy.youtube] -disabled = false -privacyEnhanced = true \ No newline at end of file + [privacy.youtube] + disabled = false + privacyEnhanced = true diff --git a/content/_index.md b/content/_index.md index 6abc75e1..ed6494b4 100644 --- a/content/_index.md +++ b/content/_index.md @@ -1,4 +1,3 @@ +++ author = "Hugo Authors" +++ - diff --git a/content/about.md b/content/about.md index a4128062..f49aec5c 100644 --- a/content/about.md +++ b/content/about.md @@ -1,8 +1,8 @@ +++ title = "About" -description = "Hugo, the world’s fastest framework for building websites" +description = "Hugo, the world's fastest framework for building websites" date = "2019-02-28" -aliases = ["about-us","about-hugo","contact"] +aliases = ["about-us", "about-hugo", "contact"] author = "Hugo Authors" +++ @@ -23,6 +23,3 @@ Hugo is for people who want to hand code their own website without worrying abou Websites built with Hugo are extremelly fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider. Learn more and contribute on [GitHub](https://github.com/gohugoio). - - - diff --git a/content/archives.md b/content/archives.md index 98a1ee9d..db16eed9 100644 --- a/content/archives.md +++ b/content/archives.md @@ -2,4 +2,4 @@ date: 2019-05-28 type: section layout: "archives" ---- \ No newline at end of file +--- diff --git a/content/homepage/about.md b/content/homepage/about.md index c2ba6802..b5d69812 100644 --- a/content/homepage/about.md +++ b/content/homepage/about.md @@ -4,4 +4,4 @@ button: 'About us' weight: 2 --- -Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. ipsum dolor sit amet, et essent mediocritatem quo, \ No newline at end of file +Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Ipsum dolor sit amet, et essent mediocritatem quo. diff --git a/content/homepage/index.md b/content/homepage/index.md index 01ffa31a..ca03031f 100644 --- a/content/homepage/index.md +++ b/content/homepage/index.md @@ -1,3 +1,3 @@ --- -headless : true +headless: true --- diff --git a/content/homepage/work.md b/content/homepage/work.md index f2fee737..f99bc997 100644 --- a/content/homepage/work.md +++ b/content/homepage/work.md @@ -4,4 +4,4 @@ button: 'Our Work' weight: 1 --- -Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Numquam dolores mel eu, mea docendi omittantur et, mea ea duis erat. Elit melius cu ius. Per ex novum tantas putant, ei his nullam aliquam apeirian. Aeterno quaestio constituto sea an, no eum intellegat assueverit. \ No newline at end of file +Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Numquam dolores mel eu, mea docendi omittantur et, mea ea duis erat. Elit melius cu ius. Per ex novum tantas putant, ei his nullam aliquam apeirian. Aeterno quaestio constituto sea an, no eum intellegat assueverit. diff --git a/content/post/_index.md b/content/post/_index.md index 7c6bd54f..8a084d90 100644 --- a/content/post/_index.md +++ b/content/post/_index.md @@ -1,5 +1,5 @@ +++ -aliases = ["posts","articles","blog","showcase","docs"] +aliases = ["posts", "articles", "blog", "showcase", "docs"] title = "Posts" author = "Hugo Authors" tags = ["index"] diff --git a/content/post/emoji-support.md b/content/post/emoji-support.md index ecf6c861..dc3589ad 100644 --- a/content/post/emoji-support.md +++ b/content/post/emoji-support.md @@ -12,8 +12,7 @@ Emoji can be enabled in a Hugo project in a number of ways. The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes). -To enable emoji globally, set `enableEmoji` to `true` in your site’s [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g. - +To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g.

🙈 :see_no_evil: 🙉 :hear_no_evil: 🙊 :speak_no_evil:


@@ -26,22 +25,22 @@ The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference {{< highlight html >}} .emoji { -font-family: Apple Color Emoji,Segoe UI Emoji,NotoColorEmoji,Segoe UI Symbol,Android Emoji,EmojiSymbols; + font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols; } {{< /highlight >}} {{< css.inline >}} -{{< /css.inline >}} \ No newline at end of file +{{< /css.inline >}} diff --git a/content/post/markdown-syntax.md b/content/post/markdown-syntax.md index 604be4e3..2aa35e1f 100644 --- a/content/post/markdown-syntax.md +++ b/content/post/markdown-syntax.md @@ -48,10 +48,9 @@ The blockquote element represents content that is quoted from another source, op #### Blockquote with attribution -> Don't communicate by sharing memory, share memory by communicating.

+> Don't communicate by sharing memory, share memory by communicating.
> — Rob Pike[^1] - [^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. ## Tables @@ -65,20 +64,19 @@ Tables aren't part of the core Markdown spec, but Hugo supports supports them ou #### Inline Markdown within tables -| Inline    | Markdown    | In    | Table | -| ---------- | --------- | ----------------- | ---------- | -| *italics* | **bold** | ~~strikethrough~~    | `code` | +| Italics | Bold | Code | +| -------- | -------- | ------ | +| *italics* | **bold** | `code` | ## Code Blocks #### Code block with backticks -``` -html - +```html + - + Example HTML5 Document @@ -86,12 +84,13 @@ html ``` + #### Code block indented with four spaces - + - + Example HTML5 Document @@ -101,10 +100,10 @@ html #### Code block with Hugo's internal highlight shortcode {{< highlight html >}} - + - + Example HTML5 Document @@ -148,4 +147,3 @@ Xn + Yn = Zn Press CTRL+ALT+Delete to end the session. Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. - diff --git a/content/post/math-typesetting.md b/content/post/math-typesetting.md index ab7b3af5..48fdc79f 100644 --- a/content/post/math-typesetting.md +++ b/content/post/math-typesetting.md @@ -15,15 +15,17 @@ In this example we will be using [KaTeX](https://katex.org/) - Within this partial reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally. - Include the partial in your templates like so: -``` +```bash {{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }} -``` +``` + - To enable KaTex globally set the parameter `math` to `true` in a project's configuration -- To enable KaTex on a per page basis include the parameter `math: true` in content files. +- To enable KaTex on a per page basis include the parameter `math: true` in content files **Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html) + {{< math.inline >}} {{ if or .Page.Params.math .Site.Params.math }} @@ -34,6 +36,7 @@ In this example we will be using [KaTeX](https://katex.org/) {{}} ### Examples + {{< math.inline >}}

Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\) @@ -44,4 +47,3 @@ Block math: $$ \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } $$ - diff --git a/content/post/placeholder-text.md b/content/post/placeholder-text.md index 378b9954..9ed5f69a 100644 --- a/content/post/placeholder-text.md +++ b/content/post/placeholder-text.md @@ -9,20 +9,14 @@ tags = [ ] +++ -Lorem est tota propiore conpellat pectoribus de -pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice -subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc -caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis -lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum. +Lorem est tota propiore conpellat pectoribus de pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum. 1. Exierant elisi ambit vivere dedere 2. Duce pollice 3. Eris modo 4. Spargitque ferrea quos palude -Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus -silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria -tractus malis. +Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis. 1. Comas hunc haec pietate fetum procerum dixit 2. Post torum vates letum Tiresia @@ -38,21 +32,14 @@ tractus malis. ## Mane refeci capiebant unda mulcebat -Victa caducifer, malo vulnere contra -dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere -furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis. +Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis. -Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli -Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare -Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert -ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae -vulnus haerentia iuste et exercebat, sui et. +Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et. -Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem -Propoetides **parte**. +Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**. {{< css.inline >}} {{< /css.inline >}}