Skip to content

Commit 88eaa3d

Browse files
committed
feat: rich mdx editor
1 parent dfca462 commit 88eaa3d

File tree

18 files changed

+1130
-9
lines changed

18 files changed

+1130
-9
lines changed

docs/mdx-editor.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
slug: /docs/mdx-editor
3+
title: MDX 编辑器(MdxEditor)
4+
---
5+
6+
import { Meta } from '@storybook/addon-docs'
7+
8+
# MDX 编辑器(MdxEditor)
9+
10+
本页面为项目级文档,介绍 `MdxEditor` 的用途、配置与示例。
11+
12+
## 组件位置
13+
14+
- 源码:`src/components/stateless/MdxEditor`
15+
- Storybook 文档:`stateless/MdxEditor`(包含 `MdxEditor.mdx` 组件文档与示例)
16+
17+
## 示例文件
18+
19+
项目内已包含示例 MDX 文件:
20+
21+
- `src/components/stateless/MdxEditor/examples/sample.mdx`(基础示例)
22+
- `src/components/stateless/MdxEditor/examples/sample-advanced.mdx`(高级示例,包含图片与 TypeScript 示例)
23+
24+
## 使用建议
25+
26+
- 若在外部系统(CMS/存储)中维护 MDX 文档,建议把文档以 `.mdx` 存储并通过 `initialMarkdown` 作为初始内容加载到 `MdxEditor`
27+
- 使用 `onChange` 回调实现自动保存或草稿功能。
28+
29+
## 快速开始
30+
31+
1. 打开 Storybook:`npm run storybook`
32+
2. 访问 `stateless/MdxEditor`,切换到 `从文件加载(示例)` 查看演示
33+
34+
---
35+
36+
如需添加更多示例或受控属性(例如 `save` 回调、自动保存策略),请在 GitHub Issue 中提出或直接提交 PR。

0 commit comments

Comments
 (0)