Skip to content

Commit

Permalink
Readme changed
Browse files Browse the repository at this point in the history
  • Loading branch information
arkokoley committed Jun 22, 2013
1 parent 0226f6f commit 67ba734
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 327 deletions.
35 changes: 20 additions & 15 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
# Sani
# Sani - Less Code. More Blogging.

Less Code. More Blogging.
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 blogging framework designed by Gaurav Koley for Jekyll, the blog aware static site generator powering Github Pages. 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 dependencies, and you’re set.
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.

# What is Sani?
Sani uses Disqus for comments and a basic, extendable, responsive theme based on [Skeleton](http://www.getskeleton.com/) .

Sani is Jekyll blogging at its finest.
#Why?

Sani sports a clean responsive theme written in semantic HTML5, focused on readability and friendliness toward mobile devices.
Code blogging is easy and beautiful. Embed code (with Solarized styling) in your posts from gists, jsFiddle or from your filesystem.
Third party integration is simple with built-in support for Twitter, Pinboard, Delicious, GitHub Repositories, Disqus Comments and Google Analytics.
It's easy to use. A collection of rake tasks simplifies development and makes deploying a cinch.
Ships with great plug-ins some original and others from the Jekyll community — tested and improved.
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.)

# Documentation
Setting up Sani is so easy, it can be done even if you don't have access to the device you regularly use.

#Installation

1. Fork Sani.
2. Rename the forked repo to 'username.github.com', where username is your username.
3. Log in to Prose.io. It works with Github, don't worry.
4. Navigate to the newly forked repo and edit the _config.yml.
5. Navigate to _posts/ in that repo, create a new file and start writing.

Check out the [Wiki](/arkokoley/sani/wiki) I'm trying my best to complete the documentation. Till then refer to this post: http://arkokoley.github.com/blog/2012/11/26/presenting-sani/
Viola! Only 5 steps and about 5 minutes to setup a blog from zero.

# Documentation

# Contributing

We love to see people contributing to Sani, whether it's a bug report, feature suggestion or a pull request. At the moment, we try to keep the core slick and lean, focusing on basic blogging needs, so some of your suggestions might not find their way into Sani. For those ideas, we started a list of 3rd party plug-ins, where you can link your own Sani plug-in repositories. For the future, we're thinking about ways to easier add them them into our main releases.
I'd love to see people contributing to Sani, whether it's a bug report, feature suggestion or a pull request.

# License

Expand All @@ -36,5 +42,4 @@ THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR I

# Want to be awesome?

Proudly display the 'Powered by Sani' credit in the footer.
Add your site to the Wiki so we can watch the community grow.
Proudly display the 'Powered by Sani' credit in the footer. Add your site to the Wiki and watch the community grow.
312 changes: 0 additions & 312 deletions Rakefile~

This file was deleted.

0 comments on commit 67ba734

Please sign in to comment.