roxeteer / cleverstack.io

cleverstack.io website

CleverStack.io

Built using Bootstrap, Jekyll and Grunt.

This repository contains the source for http://cleverstack.io website. Should you be interested in improving our website itself, please feel free. We are accepting pull requests. Get started with instructions below.

Prerequisites

1. Install Jekyll (requires v1.x).

   • Windows users: read this unofficial guide to get Jekyll up and running without problems.
   • There is also a standalone version of Jekyll which you can use instead.
   • Windows users: For Ruby 2.0.0 run chcp 65001 first to change the command prompt's character encoding.
   • In addition, ensure you have Python installed and added in your PATH or the build will fail due to our Pygments dependency.

2. Install NPM.

3. Install Grunt run npm install -g grunt-cli.

Running locally

1. If necessary, install the Prerequisites above.

2. From the root directory, run jekyll serve --watch in the command line. (Optionally) If you wish to change the styles or JavaScript used by Bootstrap. In a seperate terminal, from the root directory run npm install and then run grunt watch. The latter will auto-build the Bootstrap .less and .js files.

3. Go to http://localhost:9001 in your browser.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Important: Once a pull request has been merged, you will need to push the content of the _gh_pages folder to this repository: https://github.com/CleverStack/cleverstack.github.io then GitHub will auto generate the docs at cleverstack.github.io.

Troubleshooting

Learn more about using Jekyll by reading its documentation.

There is more detailed information on how to run Bootstrap locally in thier README.

Should you encounter problems with installing dependencies or running Grunt commands, uninstall all previous dependency versions (global and local). Then, rerun npm install.

Community

Keep track of development and community news.

• Follow @clevertech on Twitter.
• Read and subscribe to The Official Bootstrap Blog.
• Chat with fellow Bootstrappers in IRC. On the irc.freenode.net server, in the ##twitter-bootstrap channel.
• Implementation help may be found at Stack Overflow (tagged twitter-bootstrap).

Authors

Sam Deering @sdeering

Authors please add your name if you make changes to the docs.

Contributors

Contributors please add your name if you make changes to the docs.

Copyright and license

Copyright 2014 Clevertech, Inc under the MIT license.