doc: optimize HTML rendering

Defer rendering sections of docs until they are displayed on the user's screen. PR-URL: #37301 Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · May 1, 2021 · 2a3feff · 2a3feff
1 parent 8b5e42e
commit 2a3feff
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/doc/api_assets/style.css b/doc/api_assets/style.css
@@ -372,6 +372,11 @@ dd + dt.pre {
 #apicontent {
   padding-top: 1rem;
 }
+
+#apicontent section {
+  content-visibility: auto;
+  contain-intrinsic-size: 1px 5000px;
+}
 
 #apicontent .line {
   width: calc(50% - 1rem);

diff --git a/tools/doc/allhtml.js b/tools/doc/allhtml.js
@@ -36,8 +36,8 @@ for (const link of toc.match(/<a.*?>/g)) {
   contents += data.slice(0, match.index)
     .replace(/[\s\S]*?id="toc"[^>]*>\s*<\w+>.*?<\/\w+>\s*(<ul>\s*)?/, '');
 
-  apicontent += data.slice(match.index + match[0].length)
-    .replace(/<!-- API END -->[\s\S]*/, '')
+  apicontent += '<section>' + data.slice(match.index + match[0].length)
+    .replace(/<!-- API END -->[\s\S]*/, '</section>')
     .replace(/<a href="(\w[^#"]*)#/g, (match, href) => {
       return htmlFiles.includes(href) ? '<a href="#' : match;
     })

diff --git a/tools/doc/html.js b/tools/doc/html.js
@@ -66,6 +66,18 @@ const gtocHTML = unified()
 const templatePath = path.join(docPath, 'template.html');
 const template = fs.readFileSync(templatePath, 'utf8');
 
+function wrapSections(content) {
+  let firstTime = true;
+  return content.toString()
+    .replace(/<h2/g, (heading) => {
+      if (firstTime) {
+        firstTime = false;
+        return '<section>' + heading;
+      }
+      return '</section><section>' + heading;
+    }) + (firstTime ? '' : '</section>');
+}
+
 function toHTML({ input, content, filename, nodeVersion, versions }) {
   filename = path.basename(filename, '.md');
 
@@ -79,7 +91,7 @@ function toHTML({ input, content, filename, nodeVersion, versions }) {
                      .replace('__GTOC__', gtocHTML.replace(
                        `class="nav-${id}"`, `class="nav-${id} active"`))
                      .replace('__EDIT_ON_GITHUB__', editOnGitHub(filename))
-                     .replace('__CONTENT__', content.toString());
+                     .replace('__CONTENT__', wrapSections(content));
 
   const docCreated = input.match(
     /<!--\s*introduced_in\s*=\s*v([0-9]+)\.([0-9]+)\.[0-9]+\s*-->/);