https://github.com/lillallol/outline-pdf-cjs
Adds collapsible outline to pdf, taking advantage of the file system of nodejs
https://github.com/lillallol/outline-pdf-cjs
bookmarks index nodejs outline pdf pdf-bookmarks pdf-index pdf-outline
Last synced: 2 months ago
JSON representation
Adds collapsible outline to pdf, taking advantage of the file system of nodejs
- Host: GitHub
- URL: https://github.com/lillallol/outline-pdf-cjs
- Owner: lillallol
- License: mit
- Created: 2021-01-22T22:05:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T18:09:35.000Z (over 2 years ago)
- Last Synced: 2025-04-09T07:04:52.464Z (2 months ago)
- Topics: bookmarks, index, nodejs, outline, pdf, pdf-bookmarks, pdf-index, pdf-outline
- Language: JavaScript
- Homepage:
- Size: 1.01 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Table of contents
- [Description](#description)
- [Installation](#installation)
- [Example](#example)
- [License](#license)
> **NOTICE**: If you have outlined your pdf using a version from 1.0.0 to 1.0.4, then if you edit your pdf it will get corrupted due to a bug introduced by @lillallol/outline-pdf. From version 1.0.5 this bug has been resolved.
## Description
Like [@lillallol/outline-pdf](https://www.npmjs.com/package/@lillallol/outline-pdf) but with a higher level API that takes advantage of the node file system.
## Installation
```bash
npm install @lillallol/outline-pdf-cjs
```
## Example
```ts
import { outlinePdfCjs } from "@lillallol/outline-pdf-cjs";
await outlinePdfCjs({
loadPath: "path/to/pdf/to/outline.pdf",
savePath: "path/to/save/outlined.pdf",
// first column : page number
// negative for collapsing outline
// second column : outline depth
// third column : outline title
outline: `
1||Title 1
2|-|Title 2
-3|--|Title 3
4|---|Title 4
5|---|Title 5
6|-|Title 6
7||Title 7
`,
});
```
## License
[MIT](https://github.com/lillallol/outline-pdf-cjs/blob/master/LICENSE)