neoground / charm-blog
Charm Blog Module
Requires
- php: >=8.1
- neoground/charm: ^3.1
- neoground/charm-markdown: ^1.2
README
This provides blog functionalities for Charm apps.
All blog posts are markdown files with YAML frontmatter. You can easily add thumbnails and hero images and assets of all kind.
The whole blog engine runs flat-file, including comments handling. But you can also provide Redis for better performance and caching.
Installation
Begin your quest by adding charm-blog to your project via Composer:
composer require neoground/charm-blog
Next, install charm-markdown in your application:
bob cm:i neoground/charm-blog
If you haven't installed charm-markdown yet, install it as well:
bob cm:i neoground/charm-markdown
Usage
Todo. This module is in early alpha. A usage guide will follow once we reach a beta state soon.
For a reference implementation see the Markcoon project. It's a simple-to-use blog which uses this module under the hood.
Configuration
Configuration in your app's user.yaml:
rss: # Title, link, description can be multilingual, e.g. "description_de" for german title_en: My English Blog link_en: https://example.com/en/blog # Description of RSS feed description_en: Description of our blog # Absolute URL to blog index page blog_base_url: https://example.com/blog # Generator + Copyright tags generator: Charm Blog v1.0 copyright: (c) ACME Corp - All rights reserved # Path to feed icon, relative to base URL image_relpath: icon.png # Prefix to add to each post slug for the guid guid_prefix: blog