Skip to content

Commit c86d654

Browse files
committed
docs: add markdownToOdt and tiptapToOdt to README and CHANGELOG
1 parent 5f56d09 commit c86d654

2 files changed

Lines changed: 185 additions & 276 deletions

File tree

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@ All notable changes to odf-kit will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.9.6] - 2026-04-10
9+
10+
### Added
11+
12+
- **`tiptapToOdt()`** — Convert TipTap/ProseMirror JSON directly to ODT. Accepts the JSON object returned by `editor.getJSON()` in TipTap and returns a valid `.odt` file as `Uint8Array`. No dependency on `@tiptap/core` — walks the JSON tree as a plain object.
13+
- **Supported block nodes:** `doc`, `paragraph`, `heading` (levels 1–6), `bulletList`, `orderedList`, `listItem` (nested), `blockquote`, `codeBlock`, `horizontalRule`, `hardBreak`, `image`, `table`, `tableRow`, `tableCell`, `tableHeader`.
14+
- **Supported marks:** `bold`, `italic`, `underline`, `strike`, `code`, `link`, `textStyle` (color, fontSize, fontFamily), `highlight`, `superscript`, `subscript`.
15+
- **Image support:** Data URIs decoded and embedded directly. Other URLs looked up in the `images` option (`Record<src, Uint8Array>`). Unknown URLs emit a placeholder paragraph.
16+
- **`unknownNodeHandler`** callback in `TiptapToOdtOptions` — handle custom TipTap extensions without waiting for odf-kit to add support.
17+
- **`TiptapNode`**, **`TiptapMark`**, **`TiptapToOdtOptions`** types exported.
18+
- All `HtmlToOdtOptions` apply (page format, margins, orientation, metadata).
19+
- 31 new tests (817 total).
20+
821
## [0.9.5] - 2026-04-09
922

1023
### Added
@@ -142,6 +155,7 @@ Initial release. Complete ODT generation support.
142155
- Tables, page layout, headers/footers, page breaks, lists, tab stops.
143156
- Method chaining. Full TypeScript types. ESM-only, Node.js 22+. 102 tests.
144157

158+
[0.9.6]: https://github.com/GitHubNewbie0/odf-kit/releases/tag/v0.9.6
145159
[0.9.5]: https://github.com/GitHubNewbie0/odf-kit/releases/tag/v0.9.5
146160
[0.9.4]: https://github.com/GitHubNewbie0/odf-kit/releases/tag/v0.9.4
147161
[0.9.2]: https://github.com/GitHubNewbie0/odf-kit/releases/tag/v0.9.2

0 commit comments

Comments
 (0)