README.md in georgi-shinmun-0.4.1 vs README.md in georgi-shinmun-0.5
- old
+ new
@@ -1,7 +1,7 @@
Shinmun - a git-based blog engine
-==========================================
+=================================
Shinmun is a small git-based blog engine. Write posts in your favorite
editor, git-push it and serve your blog straight from a repository.
### Features
@@ -9,23 +9,22 @@
* Posts are text files formatted with [Markdown][8], [Textile][9] or [HTML][10]
* Runs on [Rack][6], [Kontrol][3] and [GitStore][7]
* Deploy via [git-push][11]
* Index, category and archive listings
* RSS feeds
-* Flickr and Delicious aggregations
* Syntax highlighting provided by [CodeRay][4]
* AJAX comment system with Markdown preview
### Quickstart
Install the gems:
$ gem sources -a http://gems.github.com
- $ gem install rack BlueCloth rubypants coderay mojombo-grit georgi-git_store georgi-kontrol georgi-shinmun
+ $ gem install rack BlueCloth rubypants coderay georgi-git_store georgi-kontrol georgi-shinmun
-Create a sample blog (this step requires the git executable):
+Create a sample blog:
$ shinmun init myblog
This will create a directory with all necessary files. Now start the
web server:
@@ -46,13 +45,11 @@
folder:
shinmun post 'The title of the post'
Shinmun will then create a post file in the right place, for example
-in `posts/2008/9/the-title-of-the-post.md`. After creating you will
-probably open the file, set the category and tags and start writing
-your new article.
+in `posts/2008/9/the-title-of-the-post.md` and open it with $EDITOR.
### Post Format
Each blog post is just a text file with a YAML header and a body. The
@@ -139,29 +136,21 @@
+ page.rhtml
### Blog configuation
-Inside `config/blog.yml` you set the properties of your blog:
+Inside `config.ru` you can set the properties of your blog:
-* title: the title of your blog, used inside templates
-* description: used for RSS
-* language: used for RSS
-* author: used for RSS
-* url: used for RSS
-* categories: a list of categories
+ blog.config = {
+ :language => 'en',
+ :title => "Blog Title",
+ :author => "The Author",
+ :categories => ["Ruby", "Javascript"],
+ :description => "Blog description"
+ }
-### Assets
-
-Shinmun serves asset files from your assets directory. Files in the
-directories `assets/stylesheets` and `assets/javascripts` will be
-served as one file each under the URLs `assets/stylesheets.css` and
-`assets/javascripts.css`. You have to name them accordingly like
-`1-reset.css` and `2-typo.css` to define the order.
-
-
### Templates
Layout and templates are rendered by *ERB*. The layout is defined in
`templates/layout.rhtml`. The content will be provided in the variable
`@content`. A minimal example:
@@ -174,20 +163,23 @@
<body>
<%= @content %>
</body>
</html>
-The attributes of a post are accessible as instance variables in a
-template:
+The attributes of a post are accessible via the @post variable:
- <div class="article">
+ <div class="article">
+
+ <h1><%= @post.title %></h1>
+
<div class="date">
- <%= date @date %>
+ <%= human_date @post.date %>
</div>
- <h2><%= @title %></h2>
- <%= @body %>
- <h3>Comments</h3>
- <!-- comment form -->
+
+ <%= @post.body_html %>
+
+ ...
+
</div>
### Commenting System