feat: stripYamlFrontmatter option

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+### Features
+
+-   Added `stripYamlFrontmatter` config option, #2381.
+
 ### Bug Fixes
 
 -   `@property` now works as expected if used to override a method's documentation.

src/lib/converter/plugins/PackagePlugin.ts

@@ -24,6 +24,9 @@ export class PackagePlugin extends ConverterComponent {
     @BindOption("readme")
     readme!: string;
 
+    @BindOption("stripYamlFrontmatter")
+    stripYamlFrontmatter!: boolean;
+
     @BindOption("entryPointStrategy")
     entryPointStrategy!: EntryPointStrategy;
 
@@ -99,7 +102,9 @@ export class PackagePlugin extends ConverterComponent {
         if (this.readme) {
             // Readme path provided, read only that file.
             try {
-                this.readmeContents = readFile(this.readme);
+                this.readmeContents = this.processReadmeContents(
+                    readFile(this.readme),
+                );
                 this.readmeFile = this.readme;
             } catch {
                 this.application.logger.error(
@@ -118,11 +123,23 @@ export class PackagePlugin extends ConverterComponent {
 
             if (result) {
                 this.readmeFile = result.file;
-                this.readmeContents = result.content;
+                this.readmeContents = this.processReadmeContents(
+                    result.content,
+                );
             }
         }
     }
 
+    private processReadmeContents(contents: string) {
+        if (this.stripYamlFrontmatter) {
+            return contents.replace(
+                /^[\r\n\s]*---\r?\n[\s\S]*?\r?\n---[\r\n\s]+/,
+                "",
+            );
+        }
+        return contents;
+    }
+
     private onBeginResolve(context: Context) {
         this.addEntries(context.project);
     }

src/lib/utils/options/declaration.ts

@@ -113,6 +113,7 @@ export interface TypeDocOptionMap {
     gitRevision: string;
     gitRemote: string;
     readme: string;
+    stripYamlFrontmatter: boolean;
 
     // Output
     out: string;

src/lib/utils/options/sources/typedoc.ts

@@ -328,6 +328,11 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         help: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.",
         type: ParameterType.Path,
     });
+    options.addDeclaration({
+        name: "stripYamlFrontmatter",
+        help: "Strip YAML frontmatter from markdown files.",
+        type: ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "cname",
         help: "Set the CNAME file text, it's useful for custom domains on GitHub Pages.",