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:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 28 insertions, 26 deletions
diff --git a/README.md b/README.md
index 617e267..322367c 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,57 @@
# Hugo HTML5up Alpha
-
-Hugo HTML5up Alpha is a port of the [Alpha by HTML5 UP](https://html5up.net/alpha) template. 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.
-
+
+Hugo HTML5up Alpha is a port of the [Alpha by HTML5 UP](https://html5up.net/alpha) template. 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.
+
![](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
```
- $ cd exampleSite && hugo server --themesDir ../..
+ $ 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/).
-
+
+ This hugo theme is licensed under the [Creative Commons Attribution 3.0 License](https://creativecommons.org/licenses/by/3.0/).
+
Read More - [LICENSE](LICENSE)