kel

Kel is a ridculously simple blog-aware markdown static site generator.

npm install kel
2 downloads in the last week
2 downloads in the last month

Kel

Kel is a ridculously simple markdown static site generation system. It is super easy to setup, simple as anything and as flexible as you can make it.

Latest Version: 0.2.0

Features

  • Easy setup: Install Kel through npm, edit some files and generate your site
  • Simple Editing: Every markdown file under the /pages folders is a page and every file under the /posts folder is a blog post. Create or edit the markdown file and you're done.
  • Flexible Theming: Write your own themes and styles and let Kel do the work.

Quick Start Guide

  1. Download and install the latest version of Node.js. It's super simple!
  2. Install Kel by running npm install kel. If you can run kel -v without any problems, you've got it installed.
  3. Start a site by running kel <site name>, where site name is your new website name.
  4. Edit the markdown files and theme files that are created and kel generate creates the static files immediately.

For further information on Kel, check out the ever-expanding Kel wiki.

Contributing

Have you made some cool hacks to Kel? Use a pull request to let us know of some cool feature or bug fix that you've made! We accept patches as long as they’re useful and conform to our standards. If you want to join the project as a contributor, please contact me with an email or via my twitter handle @koostudios. Everyone is welcome!

License

Copyright (c) 2012 Alexander Yuen koo.studios@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you