odf-kit/publiccode.yml at main · GitHubNewbie0/odf-kit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# This repository adheres to the publiccode.yml standard by including this
# metadata file that makes public software easily discoverable.
# More info at https://github.com/italia/publiccode.yml

publiccodeYmlVersion: '0.5.0'
name: odf-kit
url: 'https://github.com/GitHubNewbie0/odf-kit'
landingURL: 'https://githubnewbie0.github.io/odf-kit'
softwareVersion: 0.13.4
releaseDate: 2026-05-05
platforms:
  - web
categories:
  - document-management
  - office
  - it-development
developmentStatus: stable
softwareType: library
inputTypes:
  - application/vnd.oasis.opendocument.text
  - application/vnd.oasis.opendocument.spreadsheet
  - application/vnd.openxmlformats-officedocument.wordprocessingml.document
  - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  - text/html
  - text/markdown
  - application/json
outputTypes:
  - application/vnd.oasis.opendocument.text
  - application/vnd.oasis.opendocument.spreadsheet
  - text/html
  - text/markdown
logo: 'https://githubnewbie0.github.io/odf-kit/images/logo.svg'
maintenance:
  type: community
  contacts:
    - name: Scott Wirth
      email: scott@wirthmgt.com
legal:
  license: Apache-2.0
  mainCopyrightOwner: odf-kit contributors
  repoOwner: odf-kit contributors
intendedAudience:
  scope:
    - education
    - government
    - local-authorities
    - science-and-technology
localisation:
  localisationReady: false
  availableLanguages:
    - en
description:
  en:
    localisedName: odf-kit
    genericName: JavaScript OpenDocument ODF Library
    shortDescription: >-
      Library to generate, fill, read, and convert OpenDocument (.odt, .ods)
      files in Node.js and browsers using JavaScript or TypeScript.
    longDescription: >-
      odf-kit is an open-source TypeScript library for working with OpenDocument
      Format (ODF) documents programmatically. It provides thirteen distinct
      document modes in a single package: build ODT documents from scratch, fill
      existing .odt templates with data, convert DOCX to ODT, HTML to ODT,
      Markdown to ODT, TipTap JSON to ODT, Lexical editor state to ODT, build
      ODS spreadsheets, read ODT and ODS files, convert XLSX to ODS, convert ODT
      to Markdown, and export ODT to Typst for PDF generation. All modes work in
      Node.js 22+ and modern browsers — documents can be generated entirely
      client-side with no server required.

      The template engine fills existing .odt files created in LibreOffice with
      data using {placeholders}, loops for repeating content, conditionals for
      optional sections, and dot notation for nested data. It automatically
      handles LibreOffice's XML fragmentation of placeholder text.

      The ODT builder produces documents with rich text formatting, tables with
      cell merging and formatting, bullet and numbered lists with up to 6 levels
      of nesting, embedded images, hyperlinks, internal bookmarks, headers and
      footers with page numbers, and full page layout control. Generated files
      open in LibreOffice, Google Docs, Microsoft Word, and any ODF-compliant
      application.

      The DOCX-to-ODT converter handles headings, paragraphs, text formatting,
      tables with merged cells, nested lists, images with actual dimensions,
      hyperlinks, bookmarks, footnotes and endnotes, headers and footers, page
      layout, and tracked changes. The HTML-to-ODT and Markdown-to-ODT
      converters support all common elements including tables, lists, inline
      styles, and code blocks. HTML input is automatically normalized to
      polyglot markup before parsing, so good HTML5 from Markdown renderers,
      rich-text editors, and templating engines converts correctly without
      manual preprocessing. Compliance-sensitive users can substitute their own
      normalizer or parser implementations through documented hooks. The
      Lexical-to-ODT converter translates Lexical editor state
      (SerializedEditorState) directly to ODT, making it suitable for
      integration with Lexical-based editors such as Proton Docs.

      The ODS spreadsheet builder supports multiple sheets, auto-typed cells
      (string, number, date, boolean, formula), number formats (currency,
      percentage, decimal, integer), cell and row formatting, column widths, row
      heights, freeze rows and columns, merged cells, tab colors, and
      hyperlinks. The XLSX-to-ODS converter preserves strings, numbers,
      booleans, dates, formulas, merged cells, freeze panes, and multiple sheets
      with no additional dependencies.

      The ODT and ODS readers parse existing files into structured document
      models and can convert directly to HTML. The ODT-to-Markdown converter
      supports GFM and CommonMark output. The ODT-to-Typst emitter converts any
      ODT file to Typst markup for compilation to PDF — making it a
      zero-dependency alternative to LibreOffice headless for PDF generation.

      odf-kit generates ODF 1.2+ compliant files per ISO/IEC 26300, the
      international standard mandated by the European Union, many national
      governments, and public sector organisations for vendor independence and
      long-term document accessibility. Every generated file is validated
      against the official OASIS ODF validator in CI. The library has zero
      transitive runtime dependencies beyond fflate for ZIP packaging.
    documentation: 'https://github.com/GitHubNewbie0/odf-kit#readme'
    features:
      - >-
        Generate text documents (.odt) compatible with LibreOffice, Microsoft
        Word, and Google Docs
      - >-
        Generate spreadsheets (.ods) compatible with LibreOffice Calc and
        Microsoft Excel
      - Fill existing LibreOffice template documents with custom data
      - >-
        Repeating sections, optional sections, and nested data substitutions in
        templates
      - Convert Microsoft Word (.docx) documents to OpenDocument (.odt) format
      - >-
        Convert Microsoft Excel (.xlsx) spreadsheets to OpenDocument (.ods)
        format
      - Convert HTML web content to OpenDocument (.odt) text documents
      - Convert Markdown content to OpenDocument (.odt) text documents
      - Convert OpenDocument (.odt) to HTML for web publication
      - Convert OpenDocument (.odt) to Markdown for documentation systems
      - Convert OpenDocument (.odt) to PDF without requiring LibreOffice
      - Read and extract content from existing .odt and .ods files
      - 'Rich text formatting, tables, lists, and embedded images'
      - 'Headers, footers, page numbers, hyperlinks, and full page layout control'
      - >-
        Compliant with the ISO/IEC 26300 OpenDocument standard — every file
        validated automatically
      - >-
        Runs in web browsers and on servers — no separate document conversion
        service required
    apiDocumentation: 'https://githubnewbie0.github.io/odf-kit/api/'