Filament Markdown Editor 使用教程

1. 项目介绍

Filament Markdown Editor 是一个为 Filament 框架设计的 Markdown 编辑器。它支持代码高亮和图片上传功能，使得在 Filament 应用中处理 Markdown 内容变得更加方便。该编辑器基于 EasyMDE 实现，提供直观的编辑界面和丰富的功能。

2. 项目快速启动

首先，确保您的 Laravel 项目已经安装了 Filament。接下来，您可以通过以下步骤安装 Filament Markdown Editor：

composer require spatie/filament-markdown-editor

在您的 Filament 资源中，使用 MarkdownEditor 类来添加 Markdown 编辑器字段：

use Spatie\FilamentMarkdownEditor\MarkdownEditor;

public static function form(Form $form): Form
{
    return $form->schema([
        // 其他字段...

        MarkdownEditor::make('text')
            ->fileAttachmentsDisk('admin-uploads')
            ->fileAttachmentsVisibility('public')
            ->required(),
    ]);
}

确保您已经配置好了文件存储，并且文件上传的磁盘和可见性与上述代码中指定的匹配。

3. 应用案例和最佳实践

应用案例

• 博客文章编辑：使用 Markdown Editor 来撰写和编辑博客文章，同时利用代码高亮功能展示代码片段。
• 文档编写：创建项目文档或用户手册时，Markdown Editor 提供了简洁的编写体验。

最佳实践

• 代码高亮：在插入代码块时，确保选择正确的语言，以获得最佳的高亮效果。
• 图片上传：合理组织图片文件，以便于管理和引用。

4. 典型生态项目

Filament Markdown Editor 可以与以下生态项目配合使用，以增强功能和应用场景：

• Laravel TRIX：一个富文本编辑器，可用于创建更复杂的文本内容。
• Laravel Media Library：提供文件上传和处理功能，可以与 Markdown Editor 结合使用，管理上传的媒体文件。
• Laravel Nova：另一个流行的 Laravel 管理面板，可以与 Filament Markdown Editor 一起提供强大的后台管理功能。

通过上述介绍和指南，您可以开始使用 Filament Markdown Editor 并将其集成到您的 Laravel Filament 应用中。