diff --git a/subcategory/README.md b/subcategory/README.md new file mode 100644 index 0000000..fdd5c47 --- /dev/null +++ b/subcategory/README.md @@ -0,0 +1,51 @@ +#Subcategory Plugin# + +Adds support for subcategories in addition to article categories. + +Subcategories are heirachial. Each subcategory has a parent, which is either a +regular category or another subcategory. Subcategories with the same name but +different parents are not the same. Their articles won't be grouped together +under that name. + +##Usage## + +Subcategories are an extension to categories. Add subcategories to an article's +category metadata using a `/` like this: + + Category: Regular Category/Sub-Category/Sub-Sub-category + +then create a `subcategory.html` template in your theme similar to the +`category.html` or `tag.html` + +In your templates `article.category` continues to act the same way. Your +subcategories are stored in a list `aricles.subcategories`. To create a +breadcrumb style navigation you might try something like this: + +