https://github.com/meteorlxy/keynote-parser

A library for parsing Apple Keynote file.
https://github.com/meteorlxy/keynote-parser

iwa iwa-parser keynote keynote-parser

Last synced: 4 days ago
JSON representation

A library for parsing Apple Keynote file.

• Host: GitHub
• URL: https://github.com/meteorlxy/keynote-parser
• Owner: meteorlxy
• License: mit
• Created: 2023-02-20T11:04:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-28T03:13:29.000Z (about 2 months ago)
• Last Synced: 2024-11-02T09:51:36.103Z (11 days ago)
• Topics: iwa, iwa-parser, keynote, keynote-parser
• Language: TypeScript
• Homepage:
• Size: 3.3 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# keynote-parser2

[![github check](https://github.com/meteorlxy/keynote-parser/workflows/check/badge.svg)](https://github.com/meteorlxy/keynote-parser/actions?query=workflow%3Acheck)

[![npm](https://badgen.net/npm/v/keynote-parser2)](https://www.npmjs.com/package/keynote-parser2)

[![license](https://badgen.net/github/license/meteorlxy/keynote-parser)](https://github.com/meteorlxy/keynote-parser/blob/main/LICENSE)

A library for parsing Apple Keynote file.

## Install

```sh

npm i keynote-parser2

```

## Usage

### Command Line

Parse keynote (.key) file:

```sh

# output the parsed result to `keynote_file.key.parsed` by default

keynote-parser keynote_file.key

# specify the output directory

keynote-parser keynote_file.key keynote_file_parsed_directory

```

### Node.js API

Parse keynote (.key) file:

```ts

import { parse } from 'keynote-parser2';

await parse(

  '/path/to/keynote_file.key',

  '/path/to/keynote_file_parsed_directory',

);

```

Parse IWA (.iwa) file:

```ts

import fs from 'node:fs/promises';

import { parseIwa } from 'keynote-parser2';

const data = await fs.readFile('/path/to/iwa_file.iwa');

const iwaData = parseIwa(data);

```

## Credits

- [obriensp/iWorkFileFormat](https://github.com/obriensp/iWorkFileFormat)

- [psobot/keynote-parser](https://github.com/psobot/keynote-parser) (Python)

- [pranaygp/keynote-parser](https://github.com/pranaygp/keynote-parser) (Node.js)

## License

[MIT](https://github.com/meteorlxy/keynote-parser/blob/main/LICENSE) © [meteorlxy](https://github.com/meteorlxy) & [Contributors](https://github.com/meteorlxy/keynote-parser/graphs/contributors)