tools,doc: allow page titles to contain inline code

Previously the HTML title would be cut to the first text node only. PR-URL: #35003 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Derek Lewis <[email protected]>

Author: aduh95

test/doctool/test-doctool-html.js

@@ -9,7 +9,7 @@ try{
 }
 
 constassert=require('assert');
-const{readFile}=require('fs');
+const{readFileSync}=require('fs');
 constfixtures=require('../common/fixtures');
 const{ replaceLinks }=require('../../tools/doc/markdown.js');
 consthtml=require('../../tools/doc/html.js');
@@ -58,11 +58,6 @@ function toHTML({input, filename, nodeVersion, versions }){
 // This HTML will be stripped of all whitespace because we don't currently
 // have an HTML parser.
 consttestData=[
-{
-file: fixtures.path('sample_document.md'),
-html: '<ol><li>fish</li><li>fish</li></ol>'+
-'<ul><li>Redfish</li><li>Bluefish</li></ul>'
-},
 {
 file: fixtures.path('order_of_end_tags_5873.md'),
 html: '<h3>ClassMethod: Buffer.from(array) <span> '+
@@ -126,6 +121,10 @@ const testData = [
 'href="#foo_see_also" id="foo_see_also">#</a></span></h2><p>Check'+
 'out also<a href="https://nodejs.org/">this guide</a></p>'
 },
+{
+file: fixtures.path('document_with_special_heading.md'),
+html: '<title>Sample markdown with special heading |',
+}
 ];
 
 constspaces=/\s/g;
@@ -144,17 +143,16 @@ testData.forEach(({file, html }) =>{
 // Normalize expected data by stripping whitespace.
 constexpected=html.replace(spaces,'');
 
-readFile(file,'utf8',common.mustCall(async(err,input)=>{
-assert.ifError(err);
-constoutput=toHTML({input:input,
-filename: 'foo',
-nodeVersion: process.version,
-versions: versions});
+constinput=readFileSync(file,'utf8');
+
+constoutput=toHTML({ input,
+filename: 'foo',
+nodeVersion: process.version,
+ versions });
 
-constactual=output.replace(spaces,'');
-// Assert that the input stripped of all whitespace contains the
-// expected markup.
-assert(actual.includes(expected),
-`ACTUAL: ${actual}\nEXPECTED: ${expected}`);
-}));
+constactual=output.replace(spaces,'');
+// Assert that the input stripped of all whitespace contains the
+// expected markup.
+assert(actual.includes(expected),
+`ACTUAL: ${actual}\nEXPECTED: ${expected}`);
 });

test/fixtures/document_with_special_heading.md

@@ -0,0 +1,4 @@
+# Sample `markdown` with _special_**heading**
+
+Sometimes heading contains more than just one text child, the current file is
+there to test just that. 

tools/doc/html.js

@@ -93,12 +93,14 @@ function toHTML({input, content, filename, nodeVersion, versions }){
 // Set the section name based on the first header. Default to 'Index'.
 functionfirstHeader(){
 return(tree,file)=>{
-file.section='Index';
-
 constheading=find(tree,{type: 'heading'});
-if(heading){
-consttext=find(heading,{type: 'text'});
-if(text)file.section=text.value;
+
+if(heading&&heading.children.length){
+constrecursiveTextContent=(node)=>
+node.value||node.children.map(recursiveTextContent).join('');
+file.section=recursiveTextContent(heading);
+}else{
+file.section='Index';
 }
 };
 }