Kael.js
KaelJS is a simplest static site generator built with NodeJS/ExpressJS-Handlebars and NeDB.
Instructions
I will assume you have Node.js installed and basic knowledge of Node.js
Install the node packages.
npm install
Run
node kael-watch.js
to watch for changes on the markdown files and update the HTML files.
Open another terminal tab and run
nodemon app.js
to watch for changes on the Application and re-start the server.
Open another terminal tab and run
grunt watch
to watch for changes on the sass file or you can run
grunt build
to generate a production build
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Run
grunt test
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Done!
Author
Michael Lancaster
License
MIT License Copyright © 2013
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.