From e558827e8cd2cac68561075044897f200eb5a527 Mon Sep 17 00:00:00 2001 From: Brandon LeBoeuf <54607186+brandonleboeuf@users.noreply.github.com> Date: Thu, 27 Aug 2020 10:49:01 -0700 Subject: [PATCH] Update README.md Adds Block and Mark descriptions to read me for quick refrence --- packages/rich-text-types/README.md | 31 ++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/packages/rich-text-types/README.md b/packages/rich-text-types/README.md index 37e2900a..9c2bbac6 100644 --- a/packages/rich-text-types/README.md +++ b/packages/rich-text-types/README.md @@ -1,3 +1,34 @@ # rich-text-types Type definitions and constants for the Contentful rich text field type. + + +## Map of all Contentful block types. Blocks contain inline or block nodes. + + - DOCUMENT = 'document', + - PARAGRAPH = 'paragraph', + + - HEADING_1 = 'heading-1', + - HEADING_2 = 'heading-2', + - HEADING_3 = 'heading-3', + - HEADING_4 = 'heading-4', + - HEADING_5 = 'heading-5', + - HEADING_6 = 'heading-6', + + - OL_LIST = 'ordered-list', + - UL_LIST = 'unordered-list', + - LIST_ITEM = 'list-item', + + - HR = 'hr', + - QUOTE = 'blockquote', + + - EMBEDDED_ENTRY = 'embedded-entry-block', + - EMBEDDED_ASSET = 'embedded-asset-block', + + +## Map of all Contentful marks. */export default { + + - BOLD: 'bold', + - ITALIC: 'italic', + - UNDERLINE: 'underline', + - CODE: 'code',