Kirby Markdown Field 开源项目教程

1. 项目介绍

Kirby Markdown Field 是一个为 Kirby CMS 定制的增强型 Markdown 编辑器。它提供了丰富的文本格式化选项，包括但不限于 sophisticated 的语法高亮、基于上下文的格式切换、智能缩进以及自定义工具栏按钮等。该项目旨在替代 Kirby 默认的 Markdown 格块，以提供更佳的用户体验和功能。

2. 项目快速启动

在开始之前，请确保您的服务器环境满足以下要求：

• PHP 8.1 或更高版本
• Kirby 4.0.0 或更高版本

安装

推荐使用 Composer 进行安装：

$ composer require fabianmichael/kirby-markdown-field

或者，你也可以将此仓库下载后复制到 /site/plugins/markdown-field 目录下。

配置

在 Kirby 的字段配置中，你可以将任何 textarea 字段替换为 Markdown 字段。以下是最少的配置示例：

editor:
  label: 我的 Markdown 编辑器
  type: markdown

你也可以根据需要配置更多选项，如字体设置、工具栏按钮、键盘快捷键等。

3. 应用案例和最佳实践

案例一：集成到 Kirby 项目中

在你的 Kirby 项目中，你可以通过修改模板文件来集成 Markdown Field。

<?php
// site/snippets/editor.php
?>
<div class="markdown-editor">
  <?=$markdownField->render()?>
</div>

确保你已经正确设置了 markdownField 对象。

案例二：自定义工具栏按钮

根据你的需求，你可以自定义工具栏按钮，以下是如何添加一个新的 "Headline 4" 按钮：

buttons:
  headlines:
    - h1
    - h2
    - h3
    - h4

4. 典型生态项目

目前，Kirby Markdown Field 社区正在不断发展和壮大，以下是一些典型的生态项目：

• Markdown Field 插件扩展：社区成员开发的针对 Markdown Field 的扩展，提供更多自定义功能和集成。
• 主题和模板：专门为使用 Kirby Markdown Field 的项目设计的主题和模板，以充分利用编辑器的特性。

通过以上教程，我们希望帮助您快速上手 Kirby Markdown Field，并在您的项目中充分利用其功能。