zenoamaro/react-quill

Documentation error

Open

#355 创建于 2018年4月15日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (6,238 star) (860 fork)batch import
documentationgood first issue

描述

The README.md says:

Custom formats should not be included in the array as of version 1.0.0. Instead they should be created through Parchment and registered with the module's Quill export.

However, when I don’t include the blot names for my custom Parchment blots in the formats array, the styles aren’t applied in the Quill editor. When I do include these custom names, everything works. (react-quill 1.1.0)

贡献者指南

技术栈
javascriptreact
领域
frontend
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
Review the README.md file in the repository to locate the statement about custom formats. Test the behavior with and without custom blot names in the formats array to confirm the correct guidance. Update the documentation to reflect that custom format names should be included in the formats array for styles to apply.
Documentation error · zenoamaro/react-quill#355 | Good First Issue