README.md in almanac-0.7.2 vs README.md in almanac-0.7.3
- old
+ new
@@ -1,11 +1,11 @@
# Almanac
Almanac is the most elegant mountable blog engine that can be easily hooked up in the existing Rails application. You can read more about it in [this blog post](http://www.vasinov.com/blog/beautifully-simple-blogging).
## Main Features
- Slick default design that can be easily customized.
-- Markdown for everything.
+- kramdown (better Markdown) for all input fields.
- Drafts that make sense.
- Easy Google Analytics support.
- Akismet support for spam filtering in comments.
- Built-in social sharing with Facebook and Twitter.
- RSS support.
@@ -68,10 +68,22 @@
```ruby
Almanac.user_class = "User" # other possibilities: "Author", "Writer", etc.
```
+## Kramdown
+[Kramdown](http://kramdown.rubyforge.org/index.html) is the superset of Markdown. All input fields can use it. Check out all [syntax rules](http://kramdown.rubyforge.org/syntax.html) for kramdown. One of the best examples of kramdown usage is code highlighting that is part of Almanac. In your post you can simply write:
+
+```
+~~~ruby
+def foo
+ puts "bar"
+end
+```
+
+And it will generate a nice looking block of Ruby code once your post is published.
+
## Extending
Almanac is a mountable Rails engine, which means that all of its controllers, views and models can be rewritten in your main application. E.g. if you want to change the main layout view, create a `app/views/layouts/almanac/application.html.haml` file in your project directory that will be used automatically by Rails instead of the default Almanac layout.
This applies to all other views, models and controllers. Basically, add an `almanac` folder to any abstraction that you are willing to change and replace almanac files with your own.
@@ -87,6 +99,6 @@
## Contribute
- Fork the project.
- Write code for a feature or bug fix.
- Add Rspec tests for it.
- Commit, do not make changes to rakefile or version.
-- Submit a pull request.
\ No newline at end of file
+- Submit a pull request.