首页
/ Spatie Filament Markdown Editor 项目使用教程

Spatie Filament Markdown Editor 项目使用教程

2025-04-18 05:40:00作者:蔡怀权

1. 项目的目录结构及介绍

Spatie Filament Markdown Editor 是一个为 Filament 框架提供的 Markdown 编辑器。以下是项目的目录结构及其简单介绍:

filament-markdown-editor/
├── .github/              # GitHub 工作流和模板文件
├── docs/                 # 文档资料
├── resources/            # 资源文件,如样式表、脚本等
├── src/                  # 源代码目录
│   ├── Components/       # Vue 组件
│   ├── Http/             # HTTP 相关类
│   ├── Forms/            # 表单字段相关
│   └── ...
├── tests/                # 测试文件
├── .editorconfig          # 编辑器配置文件
├── .gitattributes         # Git 属性配置
├── .gitignore            # Git 忽略文件
├── CHANGELOG.md          # 更新日志
├── LICENSE.md            # 许可证文件
├── README.md             # 项目说明文件
├── composer.json         # Composer 配置文件
├── package.json          # Node.js 包管理配置文件
├── phpunit.xml.dist       # PHPUnit 配置文件
└── webpack.mix.js        # Webpack 配置文件

2. 项目的启动文件介绍

src/ 目录下,主要的启动文件是 MarkdownEditor.php,这是在 Filament 中注册 Markdown 编辑器字段的地方。以下是启动文件的简单介绍:

  • MarkdownEditor.php:这个文件是 Markdown 编辑器字段的主要类文件,它包含了如何将编辑器集成到 Filament 表单中的逻辑。

在 Filament 资源中使用此编辑器时,通常会通过以下方式引入:

use Spatie\FilamentMarkdownEditor\MarkdownEditor;

public static function form(Form $form): Form
{
    return $form->schema([
        // 其他字段...
        MarkdownEditor::make('text')
            ->fileAttachmentsDisk('admin-uploads')
            ->fileAttachmentsVisibility('public')
            ->required(),
    ]);
}

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行:

  • config/filament-markdown-editor.php:这个文件是用于配置 Markdown 编辑器行为的配置文件,可以设置图片上传的磁盘和可见性等。

配置文件可能看起来像这样:

return [
    'disk' => env('FILAMENT_MARKDOWN_EDITOR_DISK', 'local'),
    'path' => env('FILAMENT_MARKDOWN_EDITOR_PATH', 'uploads'),
    'visibility' => env('FILAMENT_MARKDOWN_EDITOR_VISIBILITY', 'public'),
];

在这个配置文件中,可以设置图片上传的存储磁盘、存储路径以及上传文件的可见性。这些环境变量可以在 .env 文件中定义,以便于不同环境下的配置调整。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5