mirror of
https://github.com/silverstripe/silverstripe-blog
synced 2024-10-22 11:05:58 +02:00
d2b93669ff
This no longer automatically runs during dev/build. Migration should be conscious decision to run when a developer decides to update and avoids the risk of accidentally migrating on a live site when perhaps this was not the intention. I mention the move from 1.0 to 2.0 as this is a safe migration that some version old versions. Likely the upgrade path would be best if (1) Upgrade you really old blog up to 1.0 (2) Update your codebase to 2.0 code (3) Run the migration task.
54 lines
1.9 KiB
Markdown
Executable File
54 lines
1.9 KiB
Markdown
Executable File
# SilverStripe Blog Module
|
|
|
|
[](https://travis-ci.org/silverstripe/silverstripe-blog) [](https://packagist.org/packages/silverstripe/blog) [](https://packagist.org/packages/silverstripe/blog) [](https://packagist.org/silverstripe/silverstripe/blog) [](https://packagist.org/packages/silverstripe/blog)
|
|
|
|
## Features
|
|
|
|
* [User roles](docs/en/roles.md)
|
|
* [Tags and categories](docs/en/tags-and-categories.md)
|
|
* [Custom publish dates](docs/en/custom-publish-dates.md)
|
|
* [RSS Feed](docs/en/rss-feed.md)
|
|
* [Widgets](docs/en/widgets.md) (optional)
|
|
* [Custom pagination](docs/en/pagination.md)
|
|
* [Minimal design reduces SiteTree clutter](#usage)
|
|
|
|
## Requirements
|
|
|
|
```
|
|
silverstripe/cms: ~3.1
|
|
```
|
|
|
|
### 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
|
|
|
|
```yaml
|
|
BlogPost:
|
|
show_in_sitetree: true
|
|
```
|