mirror of
https://github.com/silverstripe/silverstripe-blog
synced 2024-10-22 11:05:58 +02:00
Merge pull request #250 from flashbackzoo/pulls/better-widget-docs
Add widget docs
This commit is contained in:
commit
8c41daf398
BIN
docs/en/_images/widgets-archive.png
Normal file
BIN
docs/en/_images/widgets-archive.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
BIN
docs/en/_images/widgets-categories.png
Normal file
BIN
docs/en/_images/widgets-categories.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
BIN
docs/en/_images/widgets-recent-posts.png
Normal file
BIN
docs/en/_images/widgets-recent-posts.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
BIN
docs/en/_images/widgets-tags.png
Normal file
BIN
docs/en/_images/widgets-tags.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 13 KiB |
BIN
docs/en/_images/widgets.png
Normal file
BIN
docs/en/_images/widgets.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 82 KiB |
@ -10,6 +10,7 @@
|
||||
* Custom GridField components for quickly adding new objects.
|
||||
* RSS Feed of the blog
|
||||
* [Custom pagination](pagination.md).
|
||||
* [Widgets](widgets.md) (optional)
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
35
docs/en/widgets.md
Normal file
35
docs/en/widgets.md
Normal file
@ -0,0 +1,35 @@
|
||||
# Widgets
|
||||
|
||||
The blog module comes bundled with some useful widgets. To take advantage of them, you'll need to install the [SilverStripe widgets module](https://github.com/silverstripe/silverstripe-widgets). Widgets are totally optional - so your blog will work just fine without having widgets installed.
|
||||
|
||||
Once you have widgets installed you'll see the "Widgets" tab in the content section of your blog.
|
||||
|
||||
![](_images/widgets.png)
|
||||
|
||||
To add a widget - simply click the *plus* icon and the widget will be appear in the "Widgets currently used" column.
|
||||
|
||||
After you've finished adding widgets, publish your blog, and your freshly minted widgets will appear in your blog's sidebar.
|
||||
|
||||
## Archive
|
||||
|
||||
The archive widget helps you keep historical content relevant, by generating a list of posts, ordered by month or year.
|
||||
|
||||
![](_images/widgets-archive.png)
|
||||
|
||||
## Blog Categories
|
||||
|
||||
The blog categories widget lets your readers easily find the content they're interested in.
|
||||
|
||||
![](_images/widgets-categories.png)
|
||||
|
||||
## Recent Posts
|
||||
|
||||
The recent posts widget is great for providing quick links to your latest content.
|
||||
|
||||
![](_images/widgets-recent-posts.png)
|
||||
|
||||
## Blog Tags
|
||||
|
||||
Similar to the blog categories widget, blog tags help your readers find relevant content, at more fine grained level.
|
||||
|
||||
![](_images/widgets-tags.png)
|
Loading…
Reference in New Issue
Block a user