Browse files

Update README.md

Fix some of the formatting issues with GFM :)
  • Loading branch information...
1 parent e74c4ea commit 6981ed129c9bda95c4ac0c4a393dd671b708e62f @clee clee committed Mar 16, 2013
Showing with 26 additions and 26 deletions.
  1. +26 −26 README.md
View
52 README.md
@@ -10,42 +10,42 @@ A special content handler to manage a blog with [Punch](http://laktek.github.com
* Open your Punch project's configurations (`config.json`) and add the following:
- "plugins": {
- "content_handler": "punch-blog-content-handler"
- }
+ ```json
+ "plugins": {
+ "content_handler": "punch-blog-content-handler"
+ }
+ ```
* You can use `blog` section to provide blog specific configurations.
- "blog": {
- "posts_dir": "posts",
- "post_format": "markdown",
- "post_url": "/{year}/{month}/{date}/{title}",
- "archive_urls": {
- "all": "/archive",
- "year": "/{year}",
- "year_month": "/{year}/{month}",
- "year_month_date": "/{year}/{month}/{date}",
- "tag": "/tag/{tag}"
- }
+ ```json
+ "blog": {
+ "posts_dir": "posts",
+ "post_format": "markdown",
+ "post_url": "/{year}/{month}/{date}/{title}",
+ "archive_urls": {
+ "all": "/archive",
+ "year": "/{year}",
+ "year_month": "/{year}/{month}",
+ "year_month_date": "/{year}/{month}/{date}",
+ "tag": "/tag/{tag}"
}
+ }
+ ```
-* `posts_dir` - directory within the project, where your posts are saved. (_default: posts_)
+* `posts_dir` - directory within the project, where your posts are saved. ( _default: posts_ )
-* `post_format` - Punch will use the available parser for the given format to convert your posts to HTML. (_default: markdown_)
+* `post_format` - Punch will use the available parser for the given format to convert your posts to HTML. ( _default: markdown_ )
-* `post_url` - You can use the following tags to compose the desired post permalink - `{year}`, `{month}`, `{date}` & `{title}`. (_default: /{year}/{month}/{date}/{title}_)
+* `post_url` - You can use the following tags to compose the desired post permalink - `{year}`, `{month}`, `{date}` & `{title}`. ( _default: /{year}/{month}/{date}/{title}_ )
* `archive_url` - URLs to be used for different archive sections. Following archive sections are available.
- ** all - to show all published posts. (_default: /archive_)
-
- ** year - to show posts published in the given year. (_default: /{year}_)
-
- ** year_month - to show posts published in the given month in the year. (_default: /{year}/{month}_)
-
- ** year_month_date - to show posts published in the given date. (_default: /{year}/{month}/{date}_)
-
- ** tag - to show posts tagged with the given tag. (_default: /tag/{tag}_)
+ * `all` - to show all published posts. ( _default: /archive_ )
+ * `year` - to show posts published in the given year. ( _default: /{year}_ )
+ * `year_month` - to show posts published in the given month in the year. ( _default: /{year}/{month}_ )
+ * `year_month_date` - to show posts published in the given date. ( _default: /{year}/{month}/{date}_ )
+ * `tag` - to show posts tagged with the given tag. ( _default: /tag/{tag}_ )
Note that content handler will create only the necessary URLs for the above archive pages. You will need to create a helper to fetch the matching posts.

0 comments on commit 6981ed1

Please sign in to comment.