Skip to content

Commit

Permalink
feat: 更新prettier及其插件版本，优化代码格式化；调整Markdown编辑器相关逻辑，提升性能和可读性
Browse files Browse the repository at this point in the history
  • Loading branch information
@chenshuai2144
chenshuai2144 committed Jan 16, 2025
1 parent 74b90d8 commit 184dc92
Show file tree
Hide file tree
Showing 21 changed files with 4,069 additions and 3,936 deletions.
105 changes: 83 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,44 +3,105 @@
[![NPM version](https://img.shields.io/npm/v/@ant-design/md-editor.svg?style=flat)](https://npmjs.org/package/@ant-design/md-editor)
[![NPM downloads](http://img.shields.io/npm/dm/@ant-design/md-editor.svg?style=flat)](https://npmjs.org/package/@ant-design/md-editor)

A react library developed with dumi
一个使用 dumi 开发的 React 库

## Usage
## 用法

TODO
```tsx
import React from 'react';
import { MarkdownEditor } from '@ant-design/md-editor';

## Options
export default () => {
return (
<MarkdownEditor
initValue={`## 创始人
TODO
腾讯，全称深圳市腾讯计算机系统有限公司，是由五位创始人共同创立的，他们是马化腾、张志东、许晨晔、陈一丹和曾李青。 以下是关于这些创始人的详细信息： 马化腾 马化腾，1971 年 10 月 29 日出生于广东省东方县（现海南省东方市）八所港，广东汕头人，汉族，无党派人士。他毕业于深圳大学电子工程系计算机专业。马化腾是腾讯科技（深圳）有限公司的创始人、董事会主席、首席执行官，并曾是中华人民共和国第十二、十三届全国人民代表大会代表 。马化腾在 1998 年 11 月 11 日与合伙人共同注册成立了腾讯，并在 2004 年 6 月 16 日带领腾讯在香港联合交易所有限公司主板上市。 张志东 张志东，马化腾的同学，被称为 QQ 之父。他的计算机技术非常出色，曾是深圳大学最拔尖的学生之一。张志东在腾讯担任 CTO，并在 2014 年 9 月离职，转任腾讯公司终身荣誉顾问及腾讯学院荣誉院长等职位 。
`}
/>
);
};
```

## Development
## 选项

### MarkdownEditor

| 属性 | 类型 | 描述 |
| ----------------------- | -------------------------------------------------------------------------- | --------------------------- |
| className | `string` | 自定义类名 |
| width | `string \| number` | 编辑器宽度 |
| height | `string \| number` | 编辑器高度 |
| codeProps | `{ Languages?: string[] }` | 代码高亮配置 |
| image | `{ upload?: (file: File[] \| string[]) => Promise<string[] \| string> }` | 图片上传配置 |
| initValue | `string` | 初始内容 |
| readonly | `boolean` | 是否为只读模式 |
| style | `React.CSSProperties` | 容器样式 |
| contentStyle | `React.CSSProperties` | 内容区域样式 |
| editorStyle | `React.CSSProperties` | 编辑器样式 |
| toc | `boolean` | 是否显示目录 |
| toolBar | `ToolBarProps` | 工具栏配置 |
| rootContainer | `React.MutableRefObject<HTMLDivElement \| undefined>` | markdown 编辑器的根容器引用 |
| fncProps | `fnProps` | 功能属性配置 |
| editorRef | `React.MutableRefObject<MarkdownEditorInstance \| undefined>` | 编辑器实例引用 |
| eleItemRender | `(props: ElementProps, defaultDom: React.ReactNode) => React.ReactElement` | 自定义渲染元素 |
| initSchemaValue | `Elements[]` | 初始结构数据 |
| onChange | `(value: string, schema: Elements[]) => void` | 内容变化回调 |
| reportMode | `boolean` | 是否开启报告模式 |
| slideMode | `boolean` | 是否开启 PPT 模式 |
| typewriter | `boolean` | 是否开启打字机模式 |
| insertAutocompleteProps | `InsertAutocompleteProps` | 自动补全配置 |
| titlePlaceholderContent | `string` | 标题占位符内容 |
| comment | `Comment` | 评论功能配置 |

### ToolBarProps

| 属性 | 类型 | 描述 |
| --------- | ----------------- | ------------------------ |
| min | boolean | 控制是否启用最小化模式 |
| enable | boolean | 控制是否启用工具栏 |
| extra | React.ReactNode[] | 额外的自定义工具栏项目 |
| hideTools | ToolsKeyType[] | 指定需要隐藏的工具栏选项 |

### fnProps

| 属性 | 类型 | 描述 |
| ------ | ------------------------------------------------------------------------------- | -------------- |
| render | `(props: { children: string }, defaultDom: React.ReactNode) => React.ReactNode` | 自定义渲染元素 |

### CommentProps

| Property | Type | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| enable | `boolean` | Flag to enable/disable the component |
| onSubmit | `(id: string, comment: CommentDataType) => void` | Callback when comment is submitted |
| commentList | `CommentDataType[]` | Array of comments to display |
| deleteConfirmText | `string` | Text shown in delete confirmation dialog |
| loadMentions | `(keyword: string) => Promise<{ name: string; avatar?: string }[]>` | Function to load mention suggestions based on keyword |
| mentionsPlaceholder | `string` | Placeholder text for mentions input |
| editorRender | `(defaultDom: ReactNode) => ReactNode` | Custom render function for editor |
| previewRender | `(props: { comment: CommentDataType[] }, defaultDom: ReactNode) => React.ReactElement` | Custom render function for preview |
| onDelete | `(id: string \| number, item: CommentDataType) => void` | Callback when comment is deleted |
| listItemRender | `(doms: { checkbox: React.ReactNode; mentionsUser: React.ReactNode; children: React.ReactNode }, props: ElementProps<ListItemNode>) => React.ReactNode` | Custom render function for list items |

## 开发

```bash
# install dependencies
# 安装依赖
$ pnpm install

# develop library by docs demo
# 通过文档示例开发库
$ pnpm start

# build library source code
# 构建库源代码
$ pnpm run build

# build library source code in watch mode
# 以监视模式构建库源代码
$ pnpm run build:watch

# build docs
# 构建文档
$ pnpm run docs:build

# check your project for potential problems
# 检查项目中的潜在问题
$ pnpm run doctor
```

## LICENSE

MIT

```pie
"Dogs" : 386
"Cats" : 85
"Rats" : 15
```
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@
"jsdom": "^25.0.1",
"lint-staged": "^13.3.0",
"nwsapi": "2.2.13",
"prettier": "^2.8.8",
"prettier-plugin-organize-imports": "^3.2.4",
"prettier": "^3.0.0",
"prettier-plugin-organize-imports": "^4.1.0",
"prettier-plugin-packagejson": "^2.5.6",
"react": "^18.3.1",
"react-dom": "^18.3.1",
Expand Down
Loading

1 comment on commit 184dc92

@vercel
Copy link

@vercel vercel bot commented on 184dc92 Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

md-to-json-schema – ./

md-to-json-schema-git-main-ai-flow-task.vercel.app
md-to-json-schema-ai-flow-task.vercel.app
md-to-json-schema.vercel.app
md-to-json-schema.antdigital.dev

Please sign in to comment.