zenoamaro/react-quill

Documentation error

Open

#355 geöffnet am 15. Apr. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (6.238 Stars) (860 Forks)batch import
documentationgood first issue

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.