Sani is a blogging framework designed for Jekyll, the blog aware static site generator powering Github Pages, to be used on Github Pages with Prose.io.
Sani is a bunch of HTML, CSS and Javascript files along with a Rakefile. The HTML, CSS and JS form the theme while rake gives you automation regarding generating and publishing the blog.
Sani uses Disqus for comments and a basic, extendable, responsive theme based on Skeleton .
#Why?
To start blogging with Jekyll, you need to write your own HTML templates, CSS, Javascripts and set up your configuration. But with Sani, all you need to do is clone or fork Sani, install Jekyll (only dependency), and you’re set. All else is taken care of.(This is when you are setting up from your own computer.)
Setting up Sani is so easy, it can be done even if you don't have access to the device you regularly use.
#Installation
- Fork Sani.
- Rename the forked repo to 'username.github.com', where username is your username.
- Log in to Prose.io. It works with Github, don't worry.
- Navigate to the newly forked repo and edit the _config.yml.
- Navigate to _posts/ in that repo, create a new file and start writing.
Viola! Only 5 steps and about 5 minutes to setup a blog from zero.
I'd love to see people contributing to Sani, whether it's a bug report, feature suggestion or a pull request.
(The MIT License)
Copyright © 2012-2018 Gaurav Koley
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.
Proudly display the 'Powered by Sani' credit in the footer. Add your site to the Wiki and watch the community grow.
