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

github.com/mikeblum/hugo-now.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormblum <me@mblum.me>2017-07-03 23:50:03 +0300
committermblum <me@mblum.me>2017-07-04 00:52:52 +0300
commitb80fe49e5b1a5464ddf902e77ad9131ef3dc0ad7 (patch)
tree6838bc2dea65e331339befc849accbba8cfd9812 /README.md
parentc01e67295e86f292b3e7ab435d5349f9e86a41e3 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md135
1 files changed, 133 insertions, 2 deletions
diff --git a/README.md b/README.md
index d844d55..2401574 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,134 @@
-# hugo-now
+# Hugo Now
+
+![Powered By Hugo](https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/powered-by-hugo.png)
+
+A Hugo port of [Jekyll Now](https://github.com/barryclark/jekyll-now). The Hugo implementation is inspired by [Hemingway](https://github.com/tanksuzuki/hemingway).
+
+## Screenshots
+
+### Home Page
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/screenshots/homepage.png" alt="home page"></img>
+
+### Posts
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/screenshots/post.png" alt="post"></img>
+
+### Dashboard
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/screenshots/dashboard.png" alt="dashboard"></img>
+
+## Features
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/bootstrap-solid.png" alt="bootstrap 4" width="120px" height="120px"></img>
+
+<h3 class="mt-0">Bootstrap V4</h3>
+Update from Bootstrap 3 to 4
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/font-awesome-logo.png" alt="font awesome logo" width="120px" height="120px"></img>
+
+<h3 class="mt-0">Font Awesome</h3>
+Latest Font Awesome icons
+
+:no_good:
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/javascript.png" alt="no javascript" width="120px" height="120px"></img>
+
+<h3 class="mt-0">Progrssive Enhancement</h3>
+Disabling Javascript should retain the same experience.
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/sass.png" alt="sass" width="120px" height="120px"></img>
+
+<h3 class="mt-0">Powerful Styling</h3>
+Using the power of SASS to power our build pipeline. All major dependencies have .scss support.
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/gulp.png" alt="gulp" height="120px"></img>
+
+<h3 class="mt-0">Modern Build Pipeline</h3>
+Without Jekyll's Asset pipeline, a Hugo theme needs a build system. I opted for <a href="http://gulpjs.com/">gulp.js</a>
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/pygments-logo.png" alt="pygments" width="120px" height="120px"></img>
+
+ <h3 class="mt-0">Syntax Highlighting</h3>
+<p>
+Rather then using a JS library like <a href="https://highlightjs.org/">hightlight.js</a> I opt for server-side rendering with <a href="http://pygments.org/">Pygments</a> to keep in line with progressive enhamcements. Here is Hugo's <a href="https://gohugo.io/extras/highlighting">opinion</a> on the matter:
+<blockquote class="blockquote">
+ <p class="mb-0">The advantage of server side is that it doesn’t depend on a JavaScript library and consequently works very well when read from an RSS feed.</p>
+</blockquote>
+I would argue site usability / robustness far out weighs build times.
+</p>
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/google-analytics.png" alt="google analytics" width="120px" height="120px"></img>
+
+<h3 class="mt-0">Google Analytics</h3>
+Configure Google Analytics with:
+
+ .Params.GoogleAnalytics
+
+## Install
+
+Add Hugo Now as a submodule:
+
+`git submodule add git@github.com:mikeblum/hugo-now.git themes/hugo-now`
+
+Your `.gitmodules` should now contain:
+
+```
+[submodule "themes/hugo-now"]
+ path = themes/hugo-now
+ url = git@github.com:mikeblum/hugo-now.git
+```
+
+> Remember to commit your .gitmodules
+
+## Configure
+
+`config.yaml`
+
+```
+---
+baseurl:
+languageCode: en
+title:
+# theme
+theme: "hugo-now"
+
+taxonomies:
+ category: "categories"
+ tag: "tags"
+
+params:
+ description:
+ author:
+ keywords: []
+ avatar: /images/profile.jpg
+ displayauthor: false
+ # pygments
+ PygmentsUseClasses: true
+ PygmentsCodeFences: true
+ # pagination
+ paginate: 10
+ paginatePath: page
+ # google analytics
+ GoogleAnalytics: UA-XXXXXX
+```
+
+## Build
+
+```
+hugo server
+```
+
+You can go to localhost:1313 and this theme should be visible.
+
+## License
+
+Hugo Now is licensed under the [MIT License](LICENSE.md).
+
+## Author
+
+[Michael Blum](https://github.com/mikeblum)
+
+## Credits
+
+is based on [Hemingway](https://github.com/tanksuzuki/hemingway) created by [Asuka Suzuki](https://github.com/tanksuzuki).
-A Hugo port of [Jekyll Now](https://github.com/barryclark/jekyll-now). The Hugo implementation based based off [hucore](https://github.com/mgjohansen/hucore). \ No newline at end of file