updated linklog docs

This commit is contained in:
Brandon Mathis 2012-02-12 17:38:37 -06:00
parent 39d2075b49
commit 6b93a6a57e

View File

@ -10,7 +10,7 @@ footer: false
A linklog is a blogging format where the post titles link directly to an external site and the content of the post offers commentary on the linked piece. This is commonly referred to as a "linked list" because of the [The Daring Fireball Linked List](http://daringfireball.net/linked/) which helped to popularize the format.
Writing a linklog in Octopress is quite easy (as of [2.1](link-needed)). Simply add an `external-url` to the yaml front matter of a blog post and Octopress does the rest.
To publish a linklog with Octopress simply add the url for the item you want to write about to the `external-url` variable in the yaml front matter of a blog post.
``` yml Sample Yaml Front Matter
---
@ -22,4 +22,30 @@ external-url: http://opinionguy.com/post/uninformed-rant-vs-straw-man/
---
```
When you generate your blog, the title link will point to the external url. Also, each post will show it's own permalink, and in the feed there will be a permalink at the end of linklog posts.
## Customization
In the `_config.yml` there are some configurations you can change if you like.
``` yml Permalink and Linklog settings
permalink_label: "∞"
permalink_label_feed: "∞ Permalink"
linklog_marker: "→"
linklog_marker_position: after
linklog_marker_position_feed: after
standard_post_marker:
```
The default settings were inspired by [Marco Arment](http://marco.org) with one exception, in his RSS feed the linklog marker comes before the title to help readers better distinguish which posts are linklogs. To use that style simply change `linklog_marker_position_feed` to `before`.
John Gruber takes a different approach than Marco. Rather than mark his linklog posts, he adds the ★ character to the beginning of each of his standard posts. So for example if you wanted to copy [Daring Fireball's](http://daringfireball.net) style, you'd set it up like this.
``` yml Linklog settings like Daring Fireball
permalink_label: "★"
permalink_label_feed: "★"
linklog_marker:
linklog_marker_position:
linklog_marker_position_feed:
standard_post_marker: "★ "
```