ooxml-core 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,17 +2,21 @@
2
2
 
3
3
  # ooxml-core
4
4
 
5
+ [![npm version](https://img.shields.io/npm/v/ooxml-core.svg)](https://www.npmjs.com/package/ooxml-core)
6
+ [![license](https://img.shields.io/npm/l/ooxml-core.svg)](https://github.com/ChristopherVR/ooxml/blob/main/LICENSE)
7
+ [![types](https://img.shields.io/npm/types/ooxml-core.svg)](https://www.npmjs.com/package/ooxml-core)
8
+
5
9
  **Read, edit, validate and write Office Open XML documents in TypeScript.**
6
- One package, one XML model, every format: Word, PowerPoint, Excel and the shared building blocks beneath them. Visio and more are planned.
10
+ One package, one XML model, every format: Word, PowerPoint, Excel and the shared building blocks beneath them. Visio VSDX parsing and bounded editing are available through `ooxml-core/visio`.
7
11
 
8
12
  [![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
9
13
  [![CI](https://github.com/ChristopherVR/ooxml/actions/workflows/ci.yml/badge.svg)](https://github.com/ChristopherVR/ooxml/actions/workflows/ci.yml)
10
14
  [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
11
15
 
12
16
  [**Try the apps**](https://christophervr.github.io/ooxml/)  · 
13
- [**Packages and areas**](#one-package-many-areas)  · 
17
+ [**Packages and areas**](#features-and-api-one-package-many-areas)  · 
14
18
  [**Install**](#install)  · 
15
- [**Examples**](#examples)  · 
19
+ [**Examples**](#quick-start)  · 
16
20
  [**Roadmap**](#roadmap)  · 
17
21
  [**Contributing**](CONTRIBUTING.md)
18
22
 
@@ -26,7 +30,7 @@ One package, one XML model, every format: Word, PowerPoint, Excel and the shared
26
30
  - **Strict by default.** New code is strict TypeScript with branded measurement units, the shared `xml` area parses strictly (no DTD or entity expansion), and the `docx` area is checked against the ECMA-376 schemas in the test suite.
27
31
  - **Honest about its limits.** Unsupported features are reported, never hidden, and nothing here claims Office parity or lossless export without evidence.
28
32
 
29
- ## One package, many areas
33
+ ## Features and API: one package, many areas
30
34
 
31
35
  `ooxml-core` is a **single published package**. Every area is a subpath import, so you only load what you use, and the formats are symmetrical: `docx`, `pptx` and `xlsx` are each imported through their own subpaths, and the root entry groups only the shared building blocks by namespace.
32
36
 
@@ -67,7 +71,7 @@ npm install ooxml-core
67
71
 
68
72
  Optional peer dependencies enable specific features: `node-forge` and `xml-crypto` for digital signatures (`/pptx/signature-node`), and `@napi-rs/canvas` for server-side rasterisation.
69
73
 
70
- ## Examples
74
+ ## Quick start
71
75
 
72
76
  **Open a Word document, change it, save it**
73
77
 
@@ -124,7 +128,7 @@ bun run test:package # packs the build and imports every entry point from a cl
124
128
 
125
129
  The working agreements are in [AGENTS.md](AGENTS.md), and [PROVENANCE.md](PROVENANCE.md) records where each module came from.
126
130
 
127
- ## Related projects
131
+ ## Documentation and related projects
128
132
 
129
133
  - [docx-viewer](https://github.com/ChristopherVR/docx-viewer) and [pptx-viewer](https://github.com/ChristopherVR/pptx-viewer): the editors and viewers built on this package.
130
134
  - [OOXML Office](https://christophervr.github.io/ooxml/): the suite's launcher page (`site/`), which opens the demos those viewers deploy to their own GitHub Pages sites.