zenoamaro/react-quill

Documentation error

Open

#355 opened on Apr 15, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (6,238 stars) (860 forks)batch import
documentationgood first issue

Description

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)

Contributor guide

Tech stack
javascriptreact
Domain
frontend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.