Merge pull request #18251 from timvandermeij/docs-api-inline

Include the generated API documentation directly on the API page
mozilla · Jun 15, 2024 · ebb2db7 · ebb2db7
2 parents 831a526 + e30dda5
commit ebb2db7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/contents/api/index.md b/docs/contents/api/index.md
@@ -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>
diff --git a/docs/contents/css/main.css b/docs/contents/css/main.css
@@ -24,6 +24,12 @@ main {
     border-radius: 4px;
     padding: 10px;
   }
+
+  iframe {
+    border: none;
+    height: calc(0.55 * 100vh);
+    width: 100%;
+  }
 }
 
 footer {