A fast, clean, responsive and hardened Hugo theme.
Go to file
Alexandros 5d9d7786a2 Update HugoBasicExample Content (#45)
Closes #7 , closes #9 

The existing outdated Hugo documentation in this repo will be replaced with the following more-or-less *evergreen* content:

- **Markdown & HTML Syntax Guide** shows whether a theme has decorated basic HTML elements with CSS. Note that I have not included the Markdown syntax for aligning table columns due to: https://github.com/russross/blackfriday/issues/506

- **Rich Content** features a brief showcase of Hugo’s Privacy config and related Simple shortcodes. Note that I have chosen to embed content that showcases typography by several designers in various media including a 360° interactive YouTube video (for inspiration). Also these embeds should be covered under [Fair Use](https://fairuse.stanford.edu/overview/fair-use/what-is-fair-use/) since these are meant for teaching users how these Hugo shortcodes work.

- **Placeholder Content** includes dummy copy along with a diagram and a link with info about the *Van de Graaf Canon* for constructing layouts (that can also be applied to websites). Note: the diagram is Open Source and taken from https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon (there is a link to this page in the caption).

- **Math Typesetting** a brief tutorial about enabling KaTeX in Hugo (the Hugo Docs mention MathJax which is slower)

- **Emoji Support** brief tutorial about Hugo’s built-in Unicode emoji support (as mentioned in the Hugo Docs) but also this includes an original technique for enabling non Unicode emoji in Hugo by using Static Image Replacement with the `replaceRE` function. Note: custom icons are from the Open Source [Mutant Standard](https://mutant.tech) emoji set.

Also note that the **About** Page has been expanded and updated to reflect Hugo’s current features.

---

**NOTES**

Besides quoting from the Hugo Docs (when needed), these content files contain original content written and curated by me and whatever sources I used were modified  to such an extent that there is no need for footnotes.

The author credit for the new content is Hugo Authors since this is meant for the Hugo community -of which I am a current member- furthermore the content also may be modified by someone else in the future, so this credit seems more appropriate than one with my name.

P.S. @digitalcraftsman I have not included a guide about Modular Typography as this would have been quite involved and I am running out of time.

P.S.2 This PR also fixes the path of the `menu.main` `/about/` item see: #41 by @guylyons
2019-03-11 17:58:40 +01:00
content Update HugoBasicExample Content (#45) 2019-03-11 17:58:40 +01:00
layouts Added layouts directory to avoid error when generating site 2014-11-19 23:22:12 +07:00
static including the static directory 2014-04-26 22:47:54 -06:00
.gitignore Remove themeSite specific params from config 2015-07-10 09:53:54 +02:00
config.toml Update HugoBasicExample Content (#45) 2019-03-11 17:58:40 +01:00
confIgnore.toml Refactor HugoBasicExample (#42) 2019-03-08 17:28:41 +01:00
configPosts.toml Refactor HugoBasicExample (#42) 2019-03-08 17:28:41 +01:00
configTaxo.toml Refactor HugoBasicExample (#42) 2019-03-08 17:28:41 +01:00
LICENSE Initial commit 2014-04-26 14:46:54 -07:00
README.md Add install instructions for single theme in README.md 2018-08-08 22:11:05 +02:00

hugoBasicExample

This is an example site for Hugo.

It is intended to be a demo site for the various Hugo themes.

Using

  1. Install Hugo
  2. Clone this repository
git clone https://github.com/gohugoio/hugoBasicExample.git
cd hugoBasicExample
  1. Clone the repository you want to test. If you want to test all hugo themes, you can clone the full list
git clone --recursive https://URL/OF/YOUR/THEME themes/YOURTHEME

or

git clone --recursive https://github.com/gohugoio/hugoThemes.git themes
  1. Run Hugo and select the theme of your choosing
hugo server -t YOURTHEME