Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/dewittn/hugo-html5up-alpha.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNelson/Roberto <dewittn@gmail.com>2020-05-24 14:22:45 +0300
committerNelson/Roberto <dewittn@gmail.com>2020-05-24 14:35:25 +0300
commitbeafffbe61e99584edd20196b13cbfe0b1bed9d8 (patch)
tree7f339db02cc9c77016b783174461ce8896d2fd9b
parent37f3fa8542ca2628b43eadf993e9930ad40c331f (diff)
Updated README.md with clearer instructions, and added an example config.toml file.
-rw-r--r--README.md201
-rw-r--r--exampleSite/config.toml85
-rw-r--r--exampleSite/config/_default/config.toml1
-rw-r--r--exampleSite/config/production/config.toml35
-rw-r--r--theme.toml4
5 files changed, 264 insertions, 62 deletions
diff --git a/README.md b/README.md
index 5ab6547..76b02cc 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,144 @@
- # Hugo HTML5up Alpha
-
-Hugo HTML5up Alpha is a port of the static html template [Alpha by HTML5 UP](https://html5up.net/alpha). It is designed to mirror the look and feel of the original template as closely as possible, while taking advantage of all the best features Hugo has to offer.
-
- ![](https://github.com/dewittn/hugo-html5up-alpha/blob/master/images/screenshot.png)
-
- ## Features
-
- Theme supports pages, page bundles, menus, sections, taxonomies, and base templates.
-
- ## Demo
-
- https://hugo-html5up-alpha.nelsonroberto.com/
-
- ## Setup
-
- ### Configuration
-
- See the demo's configuration as an example:
-
- https://github.com/dewittn/hugo-html5up-alpha/blob/master/exampleSite/config/config.toml
-
- #### Hugo Internal Templates
-
- The theme currently also supports the following ["internal templates" supplied by Hugo](https://gohugo.io/templates/internal/)
-
- - [Disqus](https://gohugo.io/templates/internal/#disqus)
- - [Google Analytics](https://gohugo.io/templates/internal/#configure-google-analytics)
-
- ### Cover Image
-
- The cover image URL is hard-coded, therefore to replace this add an image to the following location in your Hugo application:
-
- ```
- /static/images/banner.jpg
- ```
-
- ## Development
-
- ### Running Locally
-
- ```
- $ git clone https://github.com/dewittn/hugo-html5up-alpha/
- $ cd hugo-html5up-alpha/exampleSite
- $ hugo server --themesDir ../..
- ```
-
- ## Original Theme Credits
-
- - [Alpha by HTML5 UP](https://html5up.net/alpha)
-
- ## License
-
- This hugo theme is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
-
- Read More - [LICENSE](LICENSE)
-
+# Hugo HTML5up Alpha
+
+Hugo HTML5up Alpha is a port of the static HTML template [Alpha by HTML5 UP](https://html5up.net/alpha). It is designed to mirror the look and feel of the original template as closely as possible while taking advantage of all the best features Hugo has to offer.
+
+![](https://github.com/dewittn/hugo-html5up-alpha/blob/master/images/screenshot.png)
+
+## Features
+
+- Blog
+- Sections
+- Taxonomies
+- Page bundles
+- Disqus Comments
+- Fontawesome icons
+- Menus and Submenus
+- OpenGraph Metadata
+- Customizable Homepage
+
+## Demo
+
+This theme comes with a more comprehensive demo, which closely mimics the original [HTML5 UP](https://html5up.net/alpha) theme and demonstrates more of its features. You can view a fully functional demo at:
+
+https://hugo-html5up-alpha.nelsonroberto.com/
+
+To run the demo locally use the following commands:
+
+```
+$ git clone https://github.com/dewittn/hugo-html5up-alpha/
+$ cd hugo-html5up-alpha/exampleSite
+$ hugo server --themesDir ../..
+```
+
+
+## Configuration
+
+See the demo's configuration as an example:
+
+https://github.com/dewittn/hugo-html5up-alpha/blob/master/exampleSite/config.toml
+
+### Homepage
+The homepage has five sections that are customizable and removable.
+
+- Banner
+- Highlight
+- Features
+- Blog
+- Call to Action
+
+Settings for the homepage come from `data\homepage.yml`.
+
+```
+### Banner ###
+banner:
+ enable: true
+ title: "Alpha"
+ content: "" # Change this if you want something other then the site description
+ buttons:
+ - title: "Sign Up"
+ link: "#"
+ class: "primary"
+ - title: "Learn More"
+ link: "#"
+
+### Highlight ###
+highlight:
+ enable: true
+ header: "Introducing the ultimate mobile app <br /> for doing stuff with your phone"
+ content: "Blandit varius ut praesent nascetur eu penatibus nisi risus faucibus nunc ornare<br /> adipiscing nunc adipiscing. Condimentum turpis massa."
+ image: "images/pic01.jpg"
+
+### Features ###
+features:
+ enable: true
+ rows:
+ - items:
+ - title: "Magna etiam"
+ icon: "fa-bolt"
+ accent: "accent2" #accent values are 1-8
+ content: "Integer volutpat ante et accumsan commophasellus sed aliquam feugiat lorem aliquet ut enim rutrum phasellus iaculis accumsan dolore magna aliquam veroeros."
+ - title: "Ipsum dolor"
+ icon: "fa-chart-area"
+ accent: "accent3" #accent values are 1-8
+ content: "Integer volutpat ante et accumsan commophasellus sed aliquam feugiat lorem aliquet ut enim rutrum phasellus iaculis accumsan dolore magna aliquam veroeros."
+ - items:
+ - title: "Sed feugiat"
+ icon: "fa-cloud"
+ accent: "accent4" #accent values are 1-8
+ content: "Integer volutpat ante et accumsan commophasellus sed aliquam feugiat lorem aliquet ut enim rutrum phasellus iaculis accumsan dolore magna aliquam veroeros."
+ - title: "Enim phasellus"
+ icon: "fa-lock"
+ accent: "accent5" #accent values are 1-8
+ content: "Integer volutpat ante et accumsan commophasellus sed aliquam feugiat lorem aliquet ut enim rutrum phasellus iaculis accumsan dolore magna aliquam veroeros."
+
+### Blog ###
+blog:
+ enable: true
+ # Leave header text blank to remove entire <section>
+ header: "Recent Posts"
+ buttonText: "Read More"
+ postCount: 2
+
+### Call to Action ###
+cta:
+ enable: true
+ header: "Sign up for beta access"
+ content: "Blandit varius ut praesent nascetur eu penatibus nisi risus faucibus nunc."
+```
+
+### Global Banner
+The global header is also configurable by modifying the `globalheader.yml` file.
+
+```
+title: "[Alpha](/) by HTML5 UP"
+button:
+ enable: true
+ title: "Sign up"
+ link: "#"
+```
+
+### Cover Image
+
+The cover image URL is hard-coded, therefore to replace this add an image to the following location in your Hugo application:
+
+```
+/static/images/banner.jpg
+```
+
+### Comments powered by Disqus
+
+The comments section is **not** shown unless a Disqus code is set in the `config.toml` file.
+
+```
+disqusShortname = "XXX"
+```
+
+## Original Theme Credits
+
+- [Alpha by HTML5 UP](https://html5up.net/alpha)
+
+## License
+
+This theme is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
+
+Read More - [LICENSE](LICENSE) \ No newline at end of file
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
new file mode 100644
index 0000000..d55cc3a
--- /dev/null
+++ b/exampleSite/config.toml
@@ -0,0 +1,85 @@
+####### This is an EXAMPLE config file!!
+####### Changes made here will not effect demo site
+
+languageCode = "en-us"
+title = "Alpha by HTML5 UP"
+baseURL = "https://example.com"
+theme = "hugo-html5up-alpha"
+disqusShortname = ""
+
+[params]
+ description = "Another fine responsive site template freebie by HTML5 UP."
+ images = ["images/pic01.jpg"]
+ author = "Hugo Port: [Nelson/Roberto](https://nelsonroberto.com/)"
+ copyright = "© Untitled. All rights reserved."
+ design = "Design: [HTML5 UP](http://html5up.net/)"
+ mainSections = ["blog"]
+
+### Footer Social Media Links ###
+[[params.share]]
+title = "facebook"
+icon = "fa-facebook-f" # fontawesome icons https://fontawesome.com/icons?d=gallery&s=brands
+link = "https://www.facebook.com/"
+
+[[params.share]]
+title = "twitter"
+icon = "fa-twitter"
+link = "https://twitter.com/"
+
+[[params.share]]
+title = "linkedin"
+icon = "fa-linkedin"
+link = "https://www.linkedin.com"
+
+### For Pages the .RelPermalink must match the menu .URL
+### For sections the name/directory must match the menu .Identifier
+[menu]
+ [[menu.main]]
+ identifier = "generic"
+ name = "Generic"
+ url = "/generic/"
+ weight = 10
+ [[menu.main]]
+ identifier = "contact"
+ name = "Contact"
+ url = "/contact/"
+ weight = 20
+ [[menu.main]]
+ identifier = "elements"
+ name = "Elements"
+ url = "/elements/"
+ weight = 30
+ [[menu.main]]
+ identifier = "blog"
+ name = "Blog"
+ url = "/blog/"
+ weight = 40
+ [[menu.main]]
+ identifier = "submenu"
+ name = "Submenu"
+ url = "#"
+ weight = 50
+ [[menu.main]]
+ parent = "submenu"
+ identifier = "one"
+ name = "Option One"
+ url = "#"
+ weight = 51
+ [[menu.main]]
+ parent = "submenu"
+ identifier = "two"
+ name = "Option Two"
+ url = "#"
+ weight = 52
+ [[menu.main]]
+ parent = "submenu"
+ identifier = "three"
+ name = "Option Three"
+ url = "#"
+ weight = 53
+ [[menu.main]]
+ parent = "submenu"
+ identifier = "four"
+ name = "Option Four"
+ url = "#"
+ weight = 54
diff --git a/exampleSite/config/_default/config.toml b/exampleSite/config/_default/config.toml
index 397bb24..dd46d4f 100644
--- a/exampleSite/config/_default/config.toml
+++ b/exampleSite/config/_default/config.toml
@@ -4,7 +4,6 @@ languageCode = "en-us"
title = "Alpha by HTML5 UP"
baseURL = "https://example.com"
theme = "hugo-html5up-alpha"
-googleanalytics = ""
disqusShortname = ""
[params]
diff --git a/exampleSite/config/production/config.toml b/exampleSite/config/production/config.toml
index 380d60f..9437bad 100644
--- a/exampleSite/config/production/config.toml
+++ b/exampleSite/config/production/config.toml
@@ -1,10 +1,41 @@
-## Everything below this is specific to the hugoBasicExample
+## Everything below is specific to the hugoBasicExample
baseURL = "https://example.com"
[params]
- description = "A Hugo port of the HTML5 UP Alpha template"
+ description = "A Hugo port of the static html template Alpha by HTML5 UP."
mainSections = ["post"]
+## Markdown Settings
+enableEmoji = true
+[markup.goldmark]
+ [markup.goldmark.extensions]
+ definitionList = true
+ footnote = true
+ linkify = true
+ strikethrough = true
+ table = true
+ taskList = true
+ typographer = true
+ [markup.goldmark.parser]
+ attribute = true
+ autoHeadingID = true
+ autoHeadingIDType = "github"
+ [markup.goldmark.renderer]
+ hardWraps = false
+ unsafe = true
+ xhtml = false
+ [markup.highlight]
+ codeFences = true
+ guessSyntax = false
+ hl_Lines = ""
+ lineNoStart = 1
+ lineNos = false
+ lineNumbersInTable = true
+ noClasses = true
+ style = "bw"
+ tabWidth = 4
+
+## Menu Settings
[menu]
[[menu.main]]
identifier = "about"
diff --git a/theme.toml b/theme.toml
index e816096..65f8d66 100644
--- a/theme.toml
+++ b/theme.toml
@@ -4,9 +4,9 @@
name = "hugo-html5up-alpha"
license = "Creative Commons"
licenselink = "https://github.com/dewittn/hugo-html5up-alpha/blob/master/LICENSE"
-description = "A hugo port of the HTML5 UP Alpha Template."
+description = "A Hugo port of the static html template Alpha by HTML5 UP."
homepage = "http://nelsonroberto.com/"
-tags = ["blog", "html5up","responsive"]
+tags = ["blog", "html5up","responsive","business"]
features = ["blog",]
min_version = "0.70.0"