Code Monkey home page Code Monkey logo

kel's Introduction

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 [email protected]

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.

kel's People

Contributors

koostudios avatar lantius avatar

Watchers

 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.