mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-11 19:58:15 +02:00
Code Activity

Include the generated API documentation directly on the API page

Browse source 
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.
This commit is contained in:
Tim van der Meij 2024-06-15 15:11:37 +02:00
parent 831a526c10
commit e30dda5261
No known key found for this signature in database
GPG key ID: 8C3FD2925A5F2762
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/contents/api/index.md
View file

@ -6,4 +6,6 @@ slug: api
# API
We're currently working on <a href="draft/index.html">better API docs</a>, but the API is well documented in [api.js](https://github.com/mozilla/pdf.js/blob/master/src/display/api.js).
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>

6
docs/contents/css/main.css
View file

@ -24,6 +24,12 @@ main {
border-radius: 4px;
padding: 10px;
}
iframe {
border: none;
height: calc(0.55 * 100vh);
width: 100%;
}
}
footer {