diff --git a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts index 73dc78a5f4f..5ec5bc9e90f 100644 --- a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts +++ b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts @@ -136,7 +136,7 @@ export class CustomMarkdownEmitter extends MarkdownEmitter { } writer.write(''); writer.write(''); - writer.writeLine(); + writer.ensureSkippedLine(); break; } diff --git a/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts b/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts index 918dd32c675..7e6b7712209 100644 --- a/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts +++ b/apps/api-documenter/src/markdown/test/CustomMarkdownEmitter.test.ts @@ -171,6 +171,13 @@ test('render Markdown from TSDoc', () => { ) ]); + output.appendNodes([ + new DocHeading({ configuration, title: 'After a table' }), + new DocParagraph({ configuration }, [ + new DocPlainText({ configuration, text: 'just checking lines after a table' }), + ]) + ]); + const stringBuilder: StringBuilder = new StringBuilder(); const apiModel: ApiModel = new ApiModel(); const markdownEmitter: CustomMarkdownEmitter = new CustomMarkdownEmitter(apiModel); diff --git a/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap b/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap index 7f57768d708..2616cbebe24 100644 --- a/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap +++ b/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap @@ -75,5 +75,10 @@ Cell 2 + +## After a table + +just checking lines after a table + " `; diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md index 265eaa5998b..1bfaa4f7169 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.md @@ -166,3 +166,4 @@ Some overload. Overrides `Class3.someOverload`. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md index 4b4ec7ab240..6b6cd8d0a07 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class1.someoverload.md @@ -45,6 +45,7 @@ boolean \| string + **Returns:** void diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md index 5a552e3e431..b952855673a 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.md @@ -161,3 +161,4 @@ Some overload. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md index 052d3bc6339..ddc7fe613a0 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.class2.somemethod.md @@ -45,6 +45,7 @@ boolean + **Returns:** void diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md index 67dcc4e42cf..e8f6984d281 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsinterfaceliketypealias.md @@ -81,3 +81,4 @@ Some prop. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md index 3664cc5386b..5192a7a9df0 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iextendsmultipleinterfaces.md @@ -96,3 +96,4 @@ A third prop. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md index 96b926cb753..015a51957b5 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface1.md @@ -73,3 +73,4 @@ Some prop. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md index 744dcd6f203..f3c7c0e45da 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.iinterface2.md @@ -54,3 +54,4 @@ Some prop. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md index f759461cbc2..30d4ba70736 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.md @@ -216,3 +216,4 @@ Some interface-like type alias. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md index cfba5977231..923ef2d33ea 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.md @@ -116,3 +116,4 @@ Some overload. + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md index 31c9eaa6e39..fe6ce4e2c5b 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.somemethod.md @@ -45,6 +45,7 @@ boolean \| string + **Returns:** void diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md index 6f93e584e94..1229bb41ccd 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload.md @@ -45,6 +45,7 @@ boolean + **Returns:** void diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md index 0f34a0914d7..a6c4c229baa 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.class3.someoverload_1.md @@ -45,6 +45,7 @@ string + **Returns:** void diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md index 3af2331d3ed..bfe2141e4f6 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/api-documenter-scenarios.namespace1.md @@ -35,3 +35,4 @@ Description + diff --git a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md index 66ef1447ad0..3fb30d96fea 100644 --- a/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md +++ b/build-tests/api-documenter-scenarios/etc/inheritedMembers/markdown/index.md @@ -27,3 +27,4 @@ Description + diff --git a/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap b/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap index 4ab557e4cfc..06d73c0c646 100644 --- a/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap +++ b/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap @@ -1363,6 +1363,7 @@ Some abstract method. + ", "/api-documenter-test.abstractclass.method.md": " @@ -1504,6 +1505,7 @@ The date when the record was created. + ", "/api-documenter-test.defaulttype.md": " @@ -1580,6 +1582,7 @@ number + ", "/api-documenter-test.docbaseclass.md": " @@ -1643,6 +1646,7 @@ The overloaded constructor for \`DocBaseClass\` + ", "/api-documenter-test.docclass1.deprecatedexample.md": " @@ -1730,6 +1734,7 @@ the second string + **Returns:** string @@ -1790,6 +1795,7 @@ the number + **Returns:** number @@ -1844,6 +1850,7 @@ some generic parameter. + **Returns:** void @@ -2252,6 +2259,7 @@ An example with tables: + ", "/api-documenter-test.docclass1.modifiedevent.md": " @@ -2330,6 +2338,7 @@ _(Optional)_ the number + **Returns:** void @@ -2440,6 +2449,7 @@ the second number to add + **Returns:** number @@ -2617,6 +2627,7 @@ These are some docs for Zero + ", "/api-documenter-test.docenumnamespacemerge.examplefunction.md": " @@ -2675,6 +2686,7 @@ This is a function inside of a namespace that merges with an enum. + ", "/api-documenter-test.ecmasymbols.example.md": " @@ -2729,6 +2741,7 @@ An ECMAScript symbol + ", "/api-documenter-test.exampleduplicatetypealias.md": " @@ -2811,6 +2824,7 @@ a system type that should NOT get hyperlinked + **Returns:** [IDocInterface1](./api-documenter-test.idocinterface1.md) @@ -2931,6 +2945,7 @@ Does something + ", "/api-documenter-test.idocinterface1.regularproperty.md": " @@ -3004,6 +3019,7 @@ Description + ", "/api-documenter-test.idocinterface3.__not.a.symbol__.md": " @@ -3173,6 +3189,7 @@ Construct signature + ", "/api-documenter-test.idocinterface3.redundantquotes.md": " @@ -3333,6 +3350,7 @@ a union type + ", "/api-documenter-test.idocinterface4.numberorfunction.md": " @@ -3419,6 +3437,7 @@ Property of type string that does something + ", "/api-documenter-test.idocinterface5.regularproperty.md": " @@ -3491,6 +3510,7 @@ T + **Returns:** T @@ -3674,6 +3694,7 @@ Description + ", "/api-documenter-test.idocinterface6.regularproperty.md": " @@ -3848,6 +3869,7 @@ _(Optional)_ Description of optionalMember + ", "/api-documenter-test.idocinterface7.optionalfield.md": " @@ -4365,6 +4387,7 @@ A type alias that references multiple other types. + ", "/api-documenter-test.outernamespace.innernamespace.md": " @@ -4405,6 +4428,7 @@ A function inside a namespace + ", "/api-documenter-test.outernamespace.innernamespace.nestedfunction.md": " @@ -4453,6 +4477,7 @@ number + **Returns:** number @@ -4523,6 +4548,7 @@ A variable exported from within a namespace. + ", "/api-documenter-test.outernamespace.nestedvariable.md": " @@ -4585,6 +4611,7 @@ handler + **Returns:** void @@ -4638,6 +4665,7 @@ Adds an handler for the event. + ", "/api-documenter-test.typealias.md": " @@ -4702,6 +4730,7 @@ This project tests various documentation generation scenarios and doc comment sy + ", } `; diff --git a/common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json b/common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json new file mode 100644 index 00000000000..0c63f1c0aca --- /dev/null +++ b/common/changes/@microsoft/api-documenter/fix-api-documenter-missing-new-lines-after-tables_2025-06-17-22-12.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@microsoft/api-documenter", + "comment": "Ensure a new line is inserted after rendering a table", + "type": "patch" + } + ], + "packageName": "@microsoft/api-documenter" +} \ No newline at end of file