Giter VIP home page Giter VIP logo

websitetemplate-static's Introduction

WARNING: This is no longer in maintenance. Feel free to use and/or extend, but use at your own risk.

Website Template - Static

This is a template to kick-start a statically generated website utilizing Foundation 5, Grunt and Jekyll.

Requirements

You'll need to have the following items installed before continuing.

  • Node.js: Use the installer provided on the NodeJS website.
  • Grunt: Run [sudo] npm install -g grunt-cli
  • Bower: Run [sudo] npm install -g bower
  • Ruby 2.1.1:
    • Mac OS X: Install Ruby 2.1.1 as described here
  • Jekyll: Run [sudo] gem install jekyll

Quickstart

gem install jekyll
git clone [email protected]/colincwilliams/websitetemplate-static.git
npm install && bower install

While you're working on your project, run:

grunt

to build it into _dev. To publish:

grunt publish

to publish to _public (minified JavaScript and compressed CSS).

Directory Strucutre

  • _src: Where all of the source files for your site come from.
    • scss/_settings.scss: Foundation configuration settings go in here
    • scss/app.scss: Application styles go here
  • _dev: Where the output of the site build occurs during development, without minified JS or compressed CSS for debugging.
  • _public: Where the output of the site build occurs for final publishing.

Grunt Plugins Used

Todo

These things are still a work in progress and will be completed as time allows.

  • Add copy task through grunt-contrib-copy
  • Copy jquery and foundation CSS and JS files for use, rather than using them directly
  • Make it so that grunt watch works correctly with Jekyll's serve for live development

websitetemplate-static's People

Contributors

colincwilliams avatar mhayes avatar rafibomb avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.