pdf.js/docs/contents/api/index.md

---
title: API
layout: layout.njk
slug: api
---

# API

The generated API documentation, from the inline comments in [api.js](https://github.com/mozilla/pdf.js/blob/master/src/display/api.js), is available below.

<iframe src="draft/index.html" title="PDF.js API documentation"></iframe>
Redo and add more documentation to gh-pages. 2014-04-10 10:01:51 -07:00			`---`
			`title: API`
Replace Wintersmith with Metalsmith Wintersmith is no longer maintained given that the most recent version is from six years ago, and all vulnerabilities that NPM reports originate from Wintersmith's dependencies. Metalsmith, and its plugins, on the other hand have recently had releases and don't have known vulnerabilities. In fact, the number of reported vulnerabilities by NPM even goes down to zero with this patch applied. This commit therefore replaces Wintersmith with Metalsmith by providing a transparent drop-in replacement, in a way that requires the least amount of changes to the code and the generated output. Note that this patch does update our versions of jQuery, Bootstrap and the Highlight.js theme because the previous versions were very outdated and didn't work correctly with Metalsmith. Moreover, those old versions contained vulnerabilities that are hereby fixed. Fixes #18198. 2024-06-13 20:53:05 +02:00			`layout: layout.njk`
			`slug: api`
Redo and add more documentation to gh-pages. 2014-04-10 10:01:51 -07:00			`---`

			`# API`

Include the generated API documentation directly on the API page This should make the API documentation slightly quicker to access for users by removing an extra click. Moreover, it makes the API documentation blend in with the rest of the website/theme (one of the points in #6526). Fixes #18249. 2024-06-15 15:11:37 +02:00			`The generated API documentation, from the inline comments in [api.js](https://github.com/mozilla/pdf.js/blob/master/src/display/api.js), is available below.`

			`<iframe src="draft/index.html" title="PDF.js API documentation"></iframe>`