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.