Changed scope of optional headings

TypeStrong · Oct 8, 2024 · 8f01072 · 8f01072
1 parent 4371c27
commit 8f01072
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 17 deletions.
diff --git a/src/lib/output/themes/default/partials/header.tsx b/src/lib/output/themes/default/partials/header.tsx
@@ -10,21 +10,22 @@ export const header = (context: DefaultThemeRenderContext, props: PageEvent<Refl
     return (
         <div class="tsd-page-title">
             {!!props.model.parent && <ul class="tsd-breadcrumb">{context.breadcrumb(props.model)}</ul>}
-            {(!props.model.isProject() || opts.project) && (!props.model.isDocument() || opts.document) && (
-                <h1 class={classNames({ deprecated: props.model.isDeprecated() })}>
-                    {props.model.kind !== ReflectionKind.Project &&
-                        `${context.internationalization.kindSingularString(props.model.kind)} `}
-                    {getDisplayName(props.model)}
-                    {hasTypeParameters(props.model) && (
-                        <>
-                            {"<"}
-                            {join(", ", props.model.typeParameters, (item) => item.name)}
-                            {">"}
-                        </>
-                    )}
-                    {context.reflectionFlags(props.model)}
-                </h1>
-            )}
+            {(!props.model.isProject() || props.url !== "index.html" || opts.readme) &&
+                (!props.model.isDocument() || opts.document) && (
+                    <h1 class={classNames({ deprecated: props.model.isDeprecated() })}>
+                        {props.model.kind !== ReflectionKind.Project &&
+                            `${context.internationalization.kindSingularString(props.model.kind)} `}
+                        {getDisplayName(props.model)}
+                        {hasTypeParameters(props.model) && (
+                            <>
+                                {"<"}
+                                {join(", ", props.model.typeParameters, (item) => item.name)}
+                                {">"}
+                            </>
+                        )}
+                        {context.reflectionFlags(props.model)}
+                    </h1>
+                )}
         </div>
     );
 };
diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
@@ -186,7 +186,7 @@ export interface TypeDocOptionMap {
         excludeReferences: boolean;
     };
     headings: {
-        project: boolean;
+        readme: boolean;
         document: boolean;
     };
     visibilityFilters: ManuallyValidatedOption<{

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -569,7 +569,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         help: (i18n) => i18n.help_headings(),
         type: ParameterType.Flags,
         defaults: {
-            project: true,
+            readme: true,
             document: false,
         },
     });