First commit.

2017-03-09 14:26:46 +01:00 · 2017-03-09 14:26:46 +01:00 · b7977e1c28
commit b7977e1c28
1 changed files with 28081 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,113 @@
+# A Hugo theme based on the Drupal zen base theme
+
+A very popular base theme for Drupal is [Zen](https://www.drupal.org/project/zen) by [JohnAlbin](https://www.drupal.org/u/johnalbin).
+
+This is a port of that theme for [Hugo :: A fast and modern static website engine](https://gohugo.io/).
+
+
+## Features
+
+* HTML5
+* Responsive design
+* Zen grids
+* Normalize CSS
+* libSass
+* Gulp.js
+* Minify css
+* jQuery 2
+* Slicknav mobile menu
+
+
+## Installation
+
+```
+$ cd themes
+$ git clone https://github.com/frjo/hugo-theme-zen.git zen
+```
+
+[Hugo - Installing Hugo](http://gohugo.io/overview/installing/)
+
+
+## config.yaml example
+
+```
+baseurl: "https://example.org/"
+title: "SiteTitle"
+
+params:
+  copyright: "This site is licensed under a 
+      [Creative Commons Attribution-ShareAlike 4.0 International License]
+      (https://creativecommons.org/licenses/by-sa/4.0/)."    # Optional
+  contact: "info@example.org"    # Optional
+  footer: "A [example.org](https://example.org/) production."    # Optional
+  poweredby: true    # Optional, show powered by hugo in footer
+  jquery: true    # Optional
+  slicknav: true    # Optional, activates a nice mobile menu.
+```
+
+
+## Shortcodes
+
+### Clear
+
+Break float.
+
+```
+{{% figure src="/images/image.jpg" class="right" %}}
+
+blablabla # Displayed left of the image.
+
+{{% clear %}}
+
+blablabla # Displayed below of the image.
+```
+
+## Use Gulp to generate css from sass
+
+Your new Zen theme uses Gulp.js as a task runner, so that it can do many
+different tasks automatically:
+
+* Build your CSS from your Sass using libSass and node-sass.
+* Add vendor prefixes for the browsers you want to support using Autoprefixer.
+* Build a style guide of your components based on the KSS comments in your Sass
+source files.
+* Lint your Sass using sass-lint.
+* Lint your JavaScript using eslint.
+* Minify the css.
+* Watch all of your files as you develop and re-build everything on the fly.
+
+Set up your front-end development build tools:
+
+1. Install Node.js and npm, the Node.js package manager.
+
+    Detailed instructions are available on the "npm quick start guide":
+    https://github.com/kss-node/kss-node/wiki/npm-quick-start-guide
+
+2. The package.json file in your new sub-theme contains the versions of all the
+Node.js software you need. To install them run:
+
+        npm install
+
+3. Install the gulp-cli tool globally. Normally, installing a Node.js globally
+is not recommended, which is why both Gulp and Grunt have created wrapper
+commands that will allow you to run "gulp" or "grunt" from anywhere, while
+using the local version of gulp or grunt that is installed in your project.
+To install gulp's global wrapper, run:
+
+        npm install -g gulp-cli
+
+5. The default gulp task will build your production minified CSS,
+build your style guide, and lint your Sass and JavaScript.
+To run the default gulp task, type:
+
+        gulp
+
+    To watch all your files as you develop, type:
+
+        gulp watch
+
+    or just type:
+
+        gulp watch:css
+  
+    to only watch the css files.