neoground/charm-blog

Charm Blog 模块

0.2 2024-02-01 16:53 UTC

This package is auto-updated.

Last update: 2024-09-30 19:03:17 UTC


README

这为 Charm 应用提供了博客功能。

所有博客文章都是 markdown 文件,带有 YAML 前置信息。您可以轻松添加缩略图和英雄图片以及各种资源。

整个博客引擎运行在平面文件上,包括评论处理。但您也可以提供 Redis 以获得更好的性能和缓存。

安装

通过 Composer 将 charm-blog 添加到您的项目中开始您的探索。

composer require neoground/charm-blog

接下来,在您的应用程序中安装 charm-markdown。

bob cm:i neoground/charm-blog

如果您还没有安装 charm-markdown,请先安装它。

bob cm:i neoground/charm-markdown

用法

待定。此模块处于早期 alpha 阶段。一旦我们进入 beta 阶段,我们将提供使用指南。

有关参考实现,请参阅 Markcoon 项目。它是一个简单易用的博客,在底层使用此模块。

配置

在您的应用程序的 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