zenoamaro/react-quill

Documentation error

Open

#355 ouverte le 15 avr. 2018

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)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)

Guide contributeur

Stack technique
javascriptreact
Domaine
frontend
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
under 1 hour
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
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.