silverstripe-blog/README.md
Nic 11af6efbae Update README to include additional requirements
This adds the additional requirements listed in the `composer.json` file.
2015-10-16 10:24:29 -05:00

2.0 KiB
Executable File

SilverStripe Blog Module

Build Status Latest Stable Version Total Downloads Latest Unstable Version License

Features

Requirements

silverstripe/cms: ~3.1
silverstripe/lumberjack: ~1.1
silverstripe/tagfield: ^1.0

Suggested Modules

silverstripe/widgets: *
silverstripe/comments: *

Installation

composer require silverstripe/blog 2.0.x-dev

Upgrading legacy blog to 2.0

If you're upgrading from blog version 1.0 to 2.0 you will need to run the BlogMigrationTask. Run the task using dev/tasks/BlogMigrationTask either via the browser or sake CLI to migrate your legacy blog to the new version data structure.

Usage

Because your blog is part of the SiteTree, usage is the same as any other page.

By default, blog posts don't appear in the SiteTree, to avoid clutter. Instead they appear inside your blog as a GridField.

If you'd rather display your posts within the SiteTree, you can do so using SilverStripe config.

In mysite/_config/settings.yml

BlogPost:
  show_in_sitetree: true