https://github.com/pixel-open/kirby-news
https://github.com/pixel-open/kirby-news
kirby-plugin
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/pixel-open/kirby-news
- Owner: Pixel-Open
- Created: 2023-10-19T13:08:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T10:15:23.000Z (over 2 years ago)
- Last Synced: 2025-02-23T17:38:23.074Z (over 1 year ago)
- Topics: kirby-plugin
- Language: PHP
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelogs.md
Awesome Lists containing this project
README
# Kirby News plugin
 [](https://getkirby.com/)
A plugin for [Kirby CMS](http://getkirby.com) to add a news module
## Requirements
+ Kirby >= 4
+ PHP >= 8
## Commercial Usage
This plugin is free
## Installation
### Download
[Download the files](https://github.com/Pixel-Open/kirby-news/releases) and place them inside `site/plugins/kirby-news`.
### Composer
```
composer require pixelopen/kirby-news
```
### Git Submodule
You can add the plugin as a Git submodule.
$ cd your/project/root
$ git submodule add https://github.com/Pixel-Open/kirby-news.git site/plugins/kirby-news
$ git submodule update --init --recursive
$ git commit -am "Add Kirby News plugin"
Run these commands to update the plugin:
$ cd your/project/root
$ git submodule foreach git checkout master
$ git submodule foreach git pull
$ git commit -am "Update submodules"
$ git submodule update --init --recursive
### Initialization
Run your website.
You should the a new page named News.
From this page you can create individual news and publish them.
## Options
If you want to use the block, you'll need to add the fieldsets `news` with the following lines in your `/site/config/config.php`:
```php
return [
'blocks' => [
'fieldsets' => [
'custom' => [
'label' => 'Custom blocks',
'type' => 'group',
'fieldsets' => [
'news',
// Other global custom blocks
]
],
'kirby' => [
'label' => 'Kirby blocks',
'type' => 'group',
'fieldsets' => [
'heading',
'text',
'list',
'quote',
'image',
'video',
'code',
'markdown'
]
]
]
]
];
```
You can also add your own fieldsets when you extend the fields, to add the `news` block and all the other block you want to use.