Download the PHP package bnomei/kirby3-feed without Composer
On this page you can find all versions of the php package bnomei/kirby3-feed. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kirby3-feed
Kirby Atom/JSON/RSS-Feed and XML-Sitemap
Generate a Atom/JSON/RSS-Feed and XML-Sitemap from Pages-Collection.
Installation
- unzip master.zip as folder
site/plugins/kirby3-feedor git submodule add https://github.com/bnomei/kirby3-feed.git site/plugins/kirby3-feedorcomposer require bnomei/kirby3-feed
Usage Feed
You can use this in a template for a dedicated feed page, in a template controller or a route.
options array defaults
If you use these defaults you need to provide the fields date (type: date) and text (type: text).
virtual page in site/config/config.php
HTML head element
rss xml
and/or rss json
TIP: Having multiple feed links is still valid html. So you can have both rss and json if you want and setup the routes properly.
Sorting
The Plugin applies a default sorting for the pages by date/modified in descending order (newest first).
- If you do not want this you have to set the
datefieldsetting to another Field name or PageMethod name. - If you want to disable sorting by the plugin and add your own you can set the option
sorttofalse.
Pitfalls when presorting by date and limit
Using sortBy('date', 'desc') will not yield expected results! In K3 sorting by date needs a callback.
Usage Sitemap
options array defaults
If you use these defaults you need to provide the fields date (type: date) and text (type: text).
virtual page in site/config.php
example for excluding pages from sitemap
see the official Kirby documentation: Filtering compendium
Settings
| bnomei.feed. | Default | Description |
|---|---|---|
| expires | 60*24*7 |
expire cache in minutes, or on any change to content |
Cache
[!Warning] If the global debug option is set to
truethe plugin will automatically flush its own cache. The plugin will automatically in-validate the cache if any of the Page objects in given Pages-Collection were modified with the Panel.
If you need to flush the cache manually, like after automated deployments or transferring files via FTP, you can use the following code:
Or simply delete the cache files/folder at site/cache/{{ HOST }}/plugins/bnomei/feed.
Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
License
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.
Credits
based on K2 versions of
