23 Star 351 Fork 47

开源中国 / tide

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

tide logo

Tide 🪼

开箱即用、扩展性强、支持 Markdown 语法、基础功能完善的 React 富文本编辑器。

Version Downloads License

在线演示

https://oschina.gitee.io/tide

示例代码

特性

  • 基于 JSON 格式存储
  • 支持 Markdown 快捷语法
    • 标题
    • 引用
    • 代码块
    • 表格
    • 超链接
    • 图片
    • 分割线
    • 粗体、斜体、删除线
    • 无序列表、有序列表、任务列表
  • 支持粘贴 Markdown 文本
  • 支持功能增强的 Table 表格
  • 支持粘贴、拖拽图片
  • 支持 Emoji 表情选择
  • 内建菜单栏
  • 支持多主题

目录

.
├── apps
│   ├── demo                      # 演示项目,部署在 Pages 上,地址:https://oschina.gitee.io/tide
│   └── legacy                    # 真实项目,Gitee 社区版正在使用,包名为 @gitee/tide-legacy
├── presets                       # 提供 @、#、! 引用(mention)功能的预知 UI 和配置,
│                                 # 主要 @gitee/tide-legacy 在使用
├── docs                          # 文档(待完善),包括:如何贡献
├── packages                      # 组织 monorepo 的包目录
│   ├── editor                    # 开箱即用的编辑器基础包,包名为 @gitee/tide
│   ├── starter-kit               # 将常用的扩展包集成在一起,配合 @gitee/tide 包使用,提供开箱即用体验
│   ├── common                    # 常用的工具类等
│   ├── react                     # 提供编辑器的 React 封装,便于在 React 项目中使用
│   ├── extension-*               # extension- 开头的包,提供编辑器的扩展功能
│   ├── tsconfig                  # 统一的 tsconfig 配置
│   └── eslint-config-custom      # 统一的 eslint 配置
└── scripts                       # 提供简化开发流程的脚本等

构建和运行

Tide 使用 turborepo 来管理多个 npm 包的编译和分发,使用 pnpm 来管理本地依赖。

git clone https://gitee.com/oschina/tide.git

cd tide

# 安装依赖
pnpm i

# 构建 packages
pnpm build

# 运行 demo 方便开发,会自动打开浏览器
pnpm dev:demo --open

由于 monorepo 依赖关系复杂,暂不支持本地构建后通过 npm linkyarn linkpnpm link --global 方式使用本地构建的版本。

贡献

谁在使用

感谢

MIT License Copyright (c) 2023 Gitee.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

🪼 开箱即用、扩展性强、支持 Markdown 语法、基础功能完善的 React 富文本编辑器。 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
TypeScript
1
https://gitee.com/oschina/tide.git
git@gitee.com:oschina/tide.git
oschina
tide
tide
main

搜索帮助