mirror of
https://github.com/silverstripe/silverstripe-blog
synced 2024-10-22 11:05:58 +02:00
improve docs
- Document new features - Document upgrading
This commit is contained in:
parent
4cdf11572a
commit
8ce3984bdc
55
README.md
55
README.md
@ -1,12 +1,53 @@
|
||||
Silverstripe Blogger
|
||||
====================
|
||||
# SilverStripe Blog Module
|
||||
|
||||
[![Build Status](https://travis-ci.org/micmania1/silverstripe-blogger.png?branch=1.0)](https://travis-ci.org/micmania1/silverstripe-blogger) [![Latest Stable Version](https://poser.pugx.org/micmania1/silverstripe-blog/v/stable.svg)](https://packagist.org/packages/micmania1/silverstripe-blog) [![Total Downloads](https://poser.pugx.org/micmania1/silverstripe-blog/downloads.svg)](https://packagist.org/packages/micmania1/silverstripe-blog) [![Latest Unstable Version](https://poser.pugx.org/micmania1/silverstripe-blog/v/unstable.svg)](https://packagist.org/packages/micmania1/silverstripe-blog) [![License](https://poser.pugx.org/micmania1/silverstripe-blog/license.svg)](https://packagist.org/packages/micmania1/silverstripe-blog)
|
||||
|
||||
A fresh take on blogging in Silverstripe set out to tackle the issue of a cluttered Site Tree.
|
||||
## Features
|
||||
|
||||
## Documentation index
|
||||
* [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)
|
||||
|
||||
* [Features](docs/en/features.md)
|
||||
* [Setup](docs/en/setup.md)
|
||||
* [Roles](docs/en/roles.md)
|
||||
## Requirements
|
||||
|
||||
```
|
||||
silverstripe/cms: ~3.1
|
||||
```
|
||||
|
||||
### Suggested Modules
|
||||
|
||||
```
|
||||
silverstripe/widgets: *
|
||||
silverstripe/comments: *
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
composer require silverstripe/blog 2.0.x-dev
|
||||
```
|
||||
|
||||
## Upgrading
|
||||
|
||||
If you're upgrading from an earlier version to 2.0, running a `dev/build` will migrate your legacy blog to the new version.
|
||||
|
||||
## 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.
|
||||
|
||||
![](docs/en/_images/blog-post-management.png)
|
||||
|
||||
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
|
||||
```
|
||||
|
BIN
docs/en/_images/post-publish-date.png
Normal file
BIN
docs/en/_images/post-publish-date.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 26 KiB |
5
docs/en/custom-publish-dates.md
Normal file
5
docs/en/custom-publish-dates.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Custom publish dates
|
||||
|
||||
Sometimes to want to write a post now, and have it published automatically, some time in the future.
|
||||
|
||||
![](_images/post-publish-date.png)
|
@ -1,22 +0,0 @@
|
||||
# Features
|
||||
|
||||
* Blog Posts extend SiteTree so no Page functionality is lost by using DataObject's.
|
||||
* Blog Posts can be listed in the SiteTree **OR** in a GridField within the blog, removing clutter for large blogs.
|
||||
* Filter blog posts by category
|
||||
* Filter blog posts by tag
|
||||
* Full blog Archive by Year, month or day
|
||||
* 4 widgets included (category listing, tag listing, archive & recent posts).
|
||||
* Publish Date - Set a blog post to publish in the future.
|
||||
* Custom GridField components for quickly adding new objects.
|
||||
* RSS Feed of the blog
|
||||
* [Custom pagination](pagination.md).
|
||||
* [Widgets](widgets.md) (optional)
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
*Easily manage and add new blog posts through a GridField.*
|
||||
![](_images/blog-post-management.png)
|
||||
|
||||
*Quickly add new tags and categories.*
|
||||
![](_images/blogpost-add-tags-categories.png)
|
3
docs/en/rss-feed.md
Normal file
3
docs/en/rss-feed.md
Normal file
@ -0,0 +1,3 @@
|
||||
# RSS feed
|
||||
|
||||
Each blog you create comes with it's own RSS feed. Access your blog's RSS feed by adding '/rss' to the end of the URL. For example http://yoursite.com/yourblog/rss/
|
@ -1,36 +0,0 @@
|
||||
# Setup
|
||||
|
||||
## Requirements
|
||||
|
||||
```
|
||||
silverstripe/cms: ~3.1
|
||||
```
|
||||
|
||||
## Suggested Modules
|
||||
|
||||
```
|
||||
silverstripe/widgets: *
|
||||
silverstripe/comments: *
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
composer require silverstripe/blog 2.0.x-dev
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Because the blog is part of the SiteTree the usage is the same as any other page.
|
||||
|
||||
By default, blog posts are filtered out of the SiteTree to avoid clutter and instead put in a GridField inside
|
||||
of the blog. If you wish to display the blog posts within the site tree you can do so using Silverstripe config.
|
||||
|
||||
In mysite/_config/settings.yml
|
||||
|
||||
```yaml
|
||||
BlogPost:
|
||||
show_in_sitetree: true
|
||||
```
|
||||
|
||||
Doing this will remove the GridField & result in a normal behaving SiteTree.
|
7
docs/en/tags-and-categories.md
Normal file
7
docs/en/tags-and-categories.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Tags and categories
|
||||
|
||||
Quickly add new tags and categories to your posts.
|
||||
|
||||
![](_images/blogpost-add-tags-categories.png)
|
||||
|
||||
We use the [SilverStripe TagField module](https://github.com/silverstripe-labs/silverstripe-tagfield) to allow easy management of tags and categories, on the fly.
|
Loading…
Reference in New Issue
Block a user