|
1 | 1 | # @kontent-ai/rich-text-resolver-markdown |
2 | 2 |
|
3 | | -## 3.0.0-beta.0 |
| 3 | +## 3.0.0 |
4 | 4 |
|
5 | 5 | ### Major Changes |
6 | 6 |
|
7 | | -- Add toMarkdown implementation for transforming Portable Text to Markdown format |
8 | | -- Restructure project into modular monorepo with separate packages for core, HTML, React, Vue, and Markdown functionality |
| 7 | +- Breaking change: Restructure project into modular monorepo with separate packages for core, HTML, React, Vue, and Markdown functionality |
9 | 8 | - Breaking change: remove legacy browser and CommonJS build support; all packages now ship ESM-only |
10 | 9 | - Breaking change: update package exports to use public barrel files and remove subpath imports from package.json |
| 10 | + |
| 11 | +### Migration Guide from v2.0.4 |
| 12 | + |
| 13 | +#### Installation |
| 14 | + |
| 15 | +**Before (v2.0.4):** |
| 16 | +```bash |
| 17 | +npm install @kontent-ai/rich-text-resolver |
| 18 | +``` |
| 19 | + |
| 20 | +**After (v3.0.0):** |
| 21 | +```bash |
| 22 | +# Install core package (required) |
| 23 | +npm install @kontent-ai/rich-text-resolver |
| 24 | + |
| 25 | +# Plus framework-specific packages as needed: |
| 26 | +npm install @kontent-ai/rich-text-resolver-html # For HTML/MAPI |
| 27 | +npm install @kontent-ai/rich-text-resolver-react # For React |
| 28 | +npm install @kontent-ai/rich-text-resolver-vue # For Vue |
| 29 | +npm install @kontent-ai/rich-text-resolver-markdown # For Markdown |
| 30 | +``` |
| 31 | + |
| 32 | +#### Import Changes |
| 33 | + |
| 34 | +The following table shows how old subpath imports map to new packages: |
| 35 | + |
| 36 | +| Old Import (v2.0.4) | New Package (v3.0.0) | New Import | |
| 37 | +|---------------------|----------------------|------------| |
| 38 | +| `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 39 | +| `@kontent-ai/rich-text-resolver/parser` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 40 | +| `@kontent-ai/rich-text-resolver/transformers/html` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 41 | +| `@kontent-ai/rich-text-resolver/transformers/portable-text` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 42 | +| `@kontent-ai/rich-text-resolver/utils` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 43 | +| `@kontent-ai/rich-text-resolver/utils/html` | `@kontent-ai/rich-text-resolver-html` | `@kontent-ai/rich-text-resolver-html` | |
| 44 | +| `@kontent-ai/rich-text-resolver/utils/mapi` | `@kontent-ai/rich-text-resolver-html` | `@kontent-ai/rich-text-resolver-html` | |
| 45 | +| `@kontent-ai/rich-text-resolver/utils/react` | `@kontent-ai/rich-text-resolver-react` | `@kontent-ai/rich-text-resolver-react` | |
| 46 | +| `@kontent-ai/rich-text-resolver/utils/vue` | `@kontent-ai/rich-text-resolver-vue` | `@kontent-ai/rich-text-resolver-vue` | |
| 47 | +| `@kontent-ai/rich-text-resolver/types/transformer` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 48 | +| `@kontent-ai/rich-text-resolver/types/parser` | `@kontent-ai/rich-text-resolver` | `@kontent-ai/rich-text-resolver` | |
| 49 | + |
| 50 | +**Example: React** |
| 51 | + |
| 52 | +Before (v2.0.4): |
| 53 | +```typescript |
| 54 | +import { transformToPortableText } from '@kontent-ai/rich-text-resolver/transformers/portable-text'; |
| 55 | +import { PortableTextReactRenderer } from '@kontent-ai/rich-text-resolver/utils/react'; |
| 56 | +``` |
| 57 | + |
| 58 | +After (v3.0.0): |
| 59 | +```typescript |
| 60 | +import { transformToPortableText } from '@kontent-ai/rich-text-resolver'; |
| 61 | +import { PortableTextReactRenderer } from '@kontent-ai/rich-text-resolver-react'; |
| 62 | +``` |
| 63 | + |
| 64 | +**Example: Vue** |
| 65 | + |
| 66 | +Before (v2.0.4): |
| 67 | +```typescript |
| 68 | +import { transformToPortableText } from '@kontent-ai/rich-text-resolver/transformers/portable-text'; |
| 69 | +import { usePortableTextVueRenderer } from '@kontent-ai/rich-text-resolver/utils/vue'; |
| 70 | +``` |
| 71 | + |
| 72 | +After (v3.0.0): |
| 73 | +```typescript |
| 74 | +import { transformToPortableText } from '@kontent-ai/rich-text-resolver'; |
| 75 | +import { usePortableTextVueRenderer } from '@kontent-ai/rich-text-resolver-vue'; |
| 76 | +``` |
| 77 | + |
| 78 | +**Example: HTML/MAPI** |
| 79 | + |
| 80 | +Before (v2.0.4): |
| 81 | +```typescript |
| 82 | +import { transformToHtml } from '@kontent-ai/rich-text-resolver/transformers/html'; |
| 83 | +import { transformToMapi } from '@kontent-ai/rich-text-resolver/utils/mapi'; |
| 84 | +``` |
| 85 | + |
| 86 | +After (v3.0.0): |
| 87 | +```typescript |
| 88 | +import { transformToHtml } from '@kontent-ai/rich-text-resolver'; |
| 89 | +import { transformToMapi } from '@kontent-ai/rich-text-resolver-html'; |
| 90 | +``` |
0 commit comments