Skip to content

Commit 31b2d05

Browse files
committed
docs: update publiccode.yml with reader capabilities
1 parent 335880b commit 31b2d05

1 file changed

Lines changed: 21 additions & 10 deletions

File tree

publiccode.yml

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ publiccodeYmlVersion: 0.5.0
22
name: odf-kit
33
url: https://github.com/GitHubNewbie0/odf-kit
44
landingURL: https://githubnewbie0.github.io/odf-kit
5-
softwareVersion: 0.4.0
6-
releaseDate: 2026-03-01
5+
softwareVersion: 0.5.0
6+
releaseDate: 2026-03-05
77
platforms:
88
- web
99
categories:
@@ -21,15 +21,15 @@ intendedAudience:
2121
description:
2222
en:
2323
localisedName: odf-kit
24-
shortDescription: TypeScript library for generating and filling OpenDocument
25-
Format (.odt) files in Node.js and browsers.
24+
shortDescription: TypeScript library for generating, filling, and reading
25+
OpenDocument Format (.odt) files in Node.js and browsers.
2626
longDescription: >-
27-
odf-kit is an open-source TypeScript library for generating and filling
28-
OpenDocument Format (ODF) documents programmatically. Build documents from
29-
scratch with a fluent API, or fill existing .odt templates created in
30-
LibreOffice with data using placeholders, loops, conditionals, and dot
31-
notation. It produces valid .odt files that open in LibreOffice, Apache
32-
OpenOffice, and any ODF-compliant application.
27+
odf-kit is an open-source TypeScript library for generating, filling, and
28+
reading OpenDocument Format (ODF) documents programmatically. Build
29+
documents from scratch with a fluent API, or fill existing .odt templates
30+
created in LibreOffice with data using placeholders, loops, conditionals,
31+
and dot notation. It produces valid .odt files that open in LibreOffice,
32+
Apache OpenOffice, and any ODF-compliant application.
3333
3434
Designed for developers building tools for governments, nonprofits,
3535
schools, and organisations that use open document standards, odf-kit
@@ -41,6 +41,13 @@ description:
4141
for optional sections, and nested data access via dot notation. Headers
4242
and footers with placeholders are processed alongside the document body.
4343
44+
odf-kit also reads existing .odt files, parsing them into a structured
45+
document model and converting to clean HTML. It is the only actively
46+
maintained pure-JavaScript ODT reader, supporting rich text with styling,
47+
tables, images with accessibility metadata, nested lists with correct
48+
numbering, footnotes and endnotes, bookmarks, text fields, and correct
49+
tracked-changes flattening.
50+
4451
Unlike abandoned alternatives such as simple-odf, odf-kit generates proper
4552
ZIP-packaged ODF files (not flat XML), supports tables with cell merging
4653
and formatting, embeds images, and is actively maintained. It has zero
@@ -66,6 +73,10 @@ description:
6673
- Hyperlinks and internal bookmarks
6774
- Headers and footers with page numbers
6875
- Page layout with size, margins, orientation, and page breaks
76+
- Read existing .odt files into a structured document model
77+
- Convert .odt to HTML with full rich text styling
78+
- Parse tables, nested lists, images, footnotes, and bookmarks
79+
- Correct tracked-changes flattening (accepted state only)
6980
- ODF 1.2+ compliant (ISO/IEC 26300)
7081
- Zero transitive runtime dependencies
7182
- Works in Node.js and browsers (client-side generation, no server required)

0 commit comments

Comments
 (0)