Project and Content Cleanup, Normalization (#61)

This commit is contained in:
Jhaura Wachsman 2020-06-03 18:34:16 +00:00 committed by GitHub
parent a83885a33e
commit e4440a1848
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 60 additions and 74 deletions

View File

@ -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/) 1. [Install Hugo](https://gohugo.io/overview/installing/)
2. Clone this repository 2. Clone this repository
```bash ```bash
git clone https://github.com/gohugoio/hugoBasicExample.git git clone https://github.com/gohugoio/hugoBasicExample.git
cd hugoBasicExample 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) 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 4. Run Hugo and select the theme of your choosing
```bash ```bash
hugo server -t YOURTHEME hugo server -t YOURTHEME
``` ```
5. Under `/content/` this repository contains the following: 5. Under `/content/` this repository contains the following:
- A section called `/post/` with sample markdown content - 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) - 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 - 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 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

View File

@ -6,7 +6,6 @@ paginate = 3
languageCode = "en" languageCode = "en"
DefaultContentLanguage = "en" DefaultContentLanguage = "en"
enableInlineShortcodes = true enableInlineShortcodes = true
footnoteReturnLinkContents = "^"
[menu] [menu]
@ -47,4 +46,3 @@ series = "series"
[services.twitter] [services.twitter]
disableInlineCSS = true disableInlineCSS = true

View File

@ -1,6 +1,5 @@
timeout = 30000 timeout = 30000
enableInlineShortcodes = true enableInlineShortcodes = true
footnoteReturnLinkContents = "^"
[taxonomies] [taxonomies]
category = "categories" category = "categories"
@ -9,20 +8,20 @@ series = "series"
[privacy] [privacy]
[privacy.vimeo] [privacy.vimeo]
disabled = false disabled = false
simple = true simple = true
[privacy.twitter] [privacy.twitter]
disabled = false disabled = false
enableDNT = true enableDNT = true
simple = true simple = true
disableInlineCSS = true disableInlineCSS = true
[privacy.instagram] [privacy.instagram]
disabled = false disabled = false
simple = true simple = true
[privacy.youtube] [privacy.youtube]
disabled = false disabled = false
privacyEnhanced = true privacyEnhanced = true

View File

@ -1,4 +1,3 @@
+++ +++
author = "Hugo Authors" author = "Hugo Authors"
+++ +++

View File

@ -1,8 +1,8 @@
+++ +++
title = "About" title = "About"
description = "Hugo, the worlds fastest framework for building websites" description = "Hugo, the world's fastest framework for building websites"
date = "2019-02-28" date = "2019-02-28"
aliases = ["about-us","about-hugo","contact"] aliases = ["about-us", "about-hugo", "contact"]
author = "Hugo Authors" 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. 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). Learn more and contribute on [GitHub](https://github.com/gohugoio).

View File

@ -4,4 +4,4 @@ button: 'About us'
weight: 2 weight: 2
--- ---
Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. ipsum dolor sit amet, et essent mediocritatem quo, Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Ipsum dolor sit amet, et essent mediocritatem quo.

View File

@ -1,3 +1,3 @@
--- ---
headless : true headless: true
--- ---

View File

@ -1,5 +1,5 @@
+++ +++
aliases = ["posts","articles","blog","showcase","docs"] aliases = ["posts", "articles", "blog", "showcase", "docs"]
title = "Posts" title = "Posts"
author = "Hugo Authors" author = "Hugo Authors"
tags = ["index"] tags = ["index"]

View File

@ -12,8 +12,7 @@ Emoji can be enabled in a Hugo project in a number of ways.
<!--more--> <!--more-->
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). 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 sites [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.
<p><span class="nowrap"><span class="emojify">🙈</span> <code>:see_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙉</span> <code>:hear_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙊</span> <code>:speak_no_evil:</code></span></p> <p><span class="nowrap"><span class="emojify">🙈</span> <code>:see_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙉</span> <code>:hear_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙊</span> <code>:speak_no_evil:</code></span></p>
<br> <br>
@ -26,14 +25,14 @@ The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference
{{< highlight html >}} {{< highlight html >}}
.emoji { .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 >}} {{< /highlight >}}
{{< css.inline >}} {{< css.inline >}}
<style> <style>
.emojify { .emojify {
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;
font-size: 2rem; font-size: 2rem;
vertical-align: middle; vertical-align: middle;
} }
@ -41,7 +40,7 @@ font-family: Apple Color Emoji,Segoe UI Emoji,NotoColorEmoji,Segoe UI Symbol,And
.nowrap { .nowrap {
display: block; display: block;
margin: 25px 0; margin: 25px 0;
} }
} }
</style> </style>
{{< /css.inline >}} {{< /css.inline >}}

View File

@ -48,10 +48,9 @@ The blockquote element represents content that is quoted from another source, op
#### Blockquote with attribution #### Blockquote with attribution
> Don't communicate by sharing memory, share memory by communicating.</p> > Don't communicate by sharing memory, share memory by communicating.<br>
> — <cite>Rob Pike[^1]</cite> > — <cite>Rob Pike[^1]</cite>
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. [^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
## Tables ## 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 within tables
| Inline&nbsp;&nbsp;&nbsp; | Markdown&nbsp;&nbsp;&nbsp; | In&nbsp;&nbsp;&nbsp; | Table | | Italics | Bold | Code |
| ---------- | --------- | ----------------- | ---------- | | -------- | -------- | ------ |
| *italics* | **bold** | ~~strikethrough~~&nbsp;&nbsp;&nbsp; | `code` | | *italics* | **bold** | `code` |
## Code Blocks ## Code Blocks
#### Code block with backticks #### Code block with backticks
``` ```html
html <!doctype html>
<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="utf-8">
<title>Example HTML5 Document</title> <title>Example HTML5 Document</title>
</head> </head>
<body> <body>
@ -86,12 +84,13 @@ html
</body> </body>
</html> </html>
``` ```
#### Code block indented with four spaces #### Code block indented with four spaces
<!DOCTYPE html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="utf-8">
<title>Example HTML5 Document</title> <title>Example HTML5 Document</title>
</head> </head>
<body> <body>
@ -101,10 +100,10 @@ html
#### Code block with Hugo's internal highlight shortcode #### Code block with Hugo's internal highlight shortcode
{{< highlight html >}} {{< highlight html >}}
<!DOCTYPE html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="utf-8">
<title>Example HTML5 Document</title> <title>Example HTML5 Document</title>
</head> </head>
<body> <body>
@ -148,4 +147,3 @@ X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session. Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures. Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.

View File

@ -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. - 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: - Include the partial in your templates like so:
``` ```bash
{{ if or .Params.math .Site.Params.math }} {{ if or .Params.math .Site.Params.math }}
{{ partial "math.html" . }} {{ partial "math.html" . }}
{{ end }} {{ end }}
``` ```
- To enable KaTex globally set the parameter `math` to `true` in a project's configuration - 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) **Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html)
{{< math.inline >}} {{< math.inline >}}
{{ if or .Page.Params.math .Site.Params.math }} {{ if or .Page.Params.math .Site.Params.math }}
<!-- KaTeX --> <!-- KaTeX -->
@ -34,6 +36,7 @@ In this example we will be using [KaTeX](https://katex.org/)
{{</ math.inline >}} {{</ math.inline >}}
### Examples ### Examples
{{< math.inline >}} {{< math.inline >}}
<p> <p>
Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\) 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} } } \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } }
$$ $$

View File

@ -9,20 +9,14 @@ tags = [
] ]
+++ +++
Lorem est tota propiore conpellat pectoribus de Lorem est tota propiore conpellat pectoribus de pectora summo. <!--more-->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.
pectora summo. <!--more-->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 1. Exierant elisi ambit vivere dedere
2. Duce pollice 2. Duce pollice
3. Eris modo 3. Eris modo
4. Spargitque ferrea quos palude 4. Spargitque ferrea quos palude
Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria
tractus malis.
1. Comas hunc haec pietate fetum procerum dixit 1. Comas hunc haec pietate fetum procerum dixit
2. Post torum vates letum Tiresia 2. Post torum vates letum Tiresia
@ -38,21 +32,14 @@ tractus malis.
## Mane refeci capiebant unda mulcebat ## Mane refeci capiebant unda mulcebat
Victa caducifer, malo vulnere contra 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.
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 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.
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 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**.
Propoetides **parte**.
{{< css.inline >}} {{< css.inline >}}
<style> <style>
.canon { background: white; width: 100%; height: auto;} .canon { background: white; width: 100%; height: auto; }
</style> </style>
{{< /css.inline >}} {{< /css.inline >}}