fix(core): emphasised header items

typedoc2md · May 3, 2024 · a1250dc · a1250dc
1 parent 346c7ca
commit a1250dc
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 64 deletions.
diff --git a/devtools/packages/fixtures/cli.ts b/devtools/packages/fixtures/cli.ts
@@ -118,8 +118,6 @@ export function writeHtml(key: string, entryPoints: string[]) {
         'Warn',
         '-out',
         fullPath,
-        '--readme',
-        'none',
       ],
       ...toEntryPoints(entryPoints),
     ],

diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/page.header.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/page.header.ts
@@ -1,4 +1,4 @@
-import { link } from '@plugin/libs/markdown';
+import { bold, link } from '@plugin/libs/markdown';
 import { MarkdownThemeContext } from '@plugin/theme';
 import * as path from 'path';
 import {
@@ -42,9 +42,9 @@ export function header(this: MarkdownThemeContext): string {
     const indexLabel = this.getText('header.docs');
 
     if (this.page.url === entryFileName) {
-      md.push(title);
+      md.push(bold(title));
     } else {
-      md.push(link(title, this.getRelativeUrl(entryFileName)));
+      md.push(link(bold(title), this.getRelativeUrl(entryFileName)));
     }
 
     const preserveReadme =
@@ -69,13 +69,13 @@ export function header(this: MarkdownThemeContext): string {
 
       if (indexLabel) {
         if (this.page.url === readMeUrl) {
-          md.push(link(indexLabel, this.getRelativeUrl(indexUrl || '')));
+          md.push(link(bold(indexLabel), this.getRelativeUrl(indexUrl || '')));
         } else {
-          md.push(indexLabel);
+          md.push(bold(indexLabel));
         }
       }
     } else {
-      md.push(indexLabel);
+      md.push(bold(indexLabel));
     }
 
     return `${md.join(' • ')}\n\n***\n`;
@@ -101,12 +101,16 @@ export function header(this: MarkdownThemeContext): string {
       ? `${packageItem.name} v${packageItem.packageVersion}`
       : packageItem.name;
 
+    const packagesMeta = this.getPackageMetaData(packageItem.name);
+    const entryModule = packagesMeta.options?.getValue('entryModule');
     const packageEntryFile = `${packageItem.name}/${entryFileName}`;
 
-    if (this.page.url === packageEntryFile) {
-      md.push(packageItemName);
+    if (this.page.url === packageEntryFile || Boolean(entryModule)) {
+      md.push(bold(packageItemName));
     } else {
-      md.push(link(packageItemName, this.getRelativeUrl(packageEntryFile)));
+      md.push(
+        link(bold(packageItemName), this.getRelativeUrl(packageEntryFile)),
+      );
     }
 
     const preservePackageReadme =
@@ -115,13 +119,15 @@ export function header(this: MarkdownThemeContext): string {
     if (preservePackageReadme) {
       if (indexLabel) {
         if (this.page.url === packageEntryFile) {
-          md.push(link(indexLabel, this.getRelativeUrl(packageItem.url || '')));
+          md.push(
+            link(bold(indexLabel), this.getRelativeUrl(packageItem.url || '')),
+          );
         } else {
-          md.push(indexLabel);
+          md.push(bold(indexLabel));
         }
       }
     } else {
-      md.push(indexLabel);
+      md.push(bold(indexLabel));
     }
 
     return `${md.join(' • ')}\n\n***\n`;

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap
@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`EntryFiles should get entry module: (Output File Strategy "members") (Option Group "1") 1`] = `
-"@scope/entryfile • Docs
+"**@scope/entryfile** • **Docs**
 
 ***
 
@@ -16,7 +16,7 @@ exports[`EntryFiles should get entry module: (Output File Strategy "members") (O
 `;
 
 exports[`EntryFiles should get entry module: (Output File Strategy "members") (Option Group "2") 1`] = `
-"@scope/entryfile • Docs
+"**@scope/entryfile** • **Docs**
 
 ***
 
@@ -31,7 +31,7 @@ exports[`EntryFiles should get entry module: (Output File Strategy "members") (O
 `;
 
 exports[`EntryFiles should get module member for members: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[@scope/entryfile](../../README.mdx) • Docs
+"[**@scope/entryfile**](../../README.mdx) • **Docs**
 
 ***
 
@@ -52,7 +52,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy
 `;
 
 exports[`EntryFiles should get module member for members: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[@scope/entryfile](../../index.mdx) • Docs
+"[**@scope/entryfile**](../../index.mdx) • **Docs**
 
 ***
 
@@ -73,7 +73,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy
 `;
 
 exports[`EntryFiles should get readme file: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[@scope/entryfile](README.mdx) • [Docs](README.mdx)
+"[**@scope/entryfile**](README.mdx) • [**Docs**](README.mdx)
 
 ***
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/groups.spec.ts.snap
@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`Groups should compile basic module index page: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -36,7 +36,7 @@ A basic module
 `;
 
 exports[`Groups should compile basic module index page: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -74,7 +74,7 @@ A basic module
 `;
 
 exports[`Groups should compile basic module index page: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -153,7 +153,7 @@ A basic module
 `;
 
 exports[`Groups should compile basic module index page: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -254,7 +254,7 @@ A basic module
 `;
 
 exports[`Groups should compile categories group page: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -311,7 +311,7 @@ A module that contains categories
 `;
 
 exports[`Groups should compile categories group page: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -384,7 +384,7 @@ A module that contains categories
 `;
 
 exports[`Groups should compile categories index page: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -431,7 +431,7 @@ A module that contains categories
 `;
 
 exports[`Groups should compile categories index page: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -471,7 +471,7 @@ A module that contains categories
 `;
 
 exports[`Groups should compile custom groups index page: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -499,7 +499,7 @@ A module that contains custom groupings
 `;
 
 exports[`Groups should compile custom groups index page: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -544,7 +544,7 @@ Default grouping
 `;
 
 exports[`Groups should compile index page for project: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -565,7 +565,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "me
 `;
 
 exports[`Groups should compile index page for project: (Output File Strategy "members") (Option Group "2") 1`] = `
-"typedoc-stubs • Docs
+"**typedoc-stubs** • **Docs**
 
 ***
 
@@ -586,7 +586,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "me
 `;
 
 exports[`Groups should compile index page for project: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -607,7 +607,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "mo
 `;
 
 exports[`Groups should compile index page for project: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"typedoc-stubs • Docs
+"**typedoc-stubs** • **Docs**
 
 ***
 
@@ -628,7 +628,7 @@ exports[`Groups should compile index page for project: (Output File Strategy "mo
 `;
 
 exports[`Groups should compile module index for a namespace: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../../../index.md) • Docs
+"[**typedoc-stubs**](../../../index.md) • **Docs**
 
 ***
 
@@ -649,7 +649,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate
 `;
 
 exports[`Groups should compile module index for a namespace: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../../../index.md) • Docs
+"[**typedoc-stubs**](../../../index.md) • **Docs**
 
 ***
 
@@ -667,7 +667,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate
 `;
 
 exports[`Groups should compile module index for a namespace: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](../../../index.md) • Docs
+"[**typedoc-stubs**](../../../index.md) • **Docs**
 
 ***
 
@@ -688,7 +688,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate
 `;
 
 exports[`Groups should compile module index for a namespace: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"[typedoc-stubs](../../../index.md) • Docs
+"[**typedoc-stubs**](../../../index.md) • **Docs**
 
 ***
 
@@ -709,7 +709,7 @@ exports[`Groups should compile module index for a namespace: (Output File Strate
 `;
 
 exports[`Groups should compile module index with namespaces index page: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -759,7 +759,7 @@ A module that contains namespaces
 `;
 
 exports[`Groups should compile module index with namespaces index page: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -839,7 +839,7 @@ A module that contains namespaces
 `;
 
 exports[`Groups should compile module index with namespaces index page: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -947,7 +947,7 @@ A module that contains namespaces
 `;
 
 exports[`Groups should compile module index with namespaces index page: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -1081,7 +1081,7 @@ A module that contains namespaces
 `;
 
 exports[`Groups should compile readme for a project: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"typedoc-stubs • [Docs](modules.md)
+"**typedoc-stubs** • [**Docs**](modules.md)
 
 ***
 
@@ -1098,7 +1098,7 @@ Some text.
 `;
 
 exports[`Groups should compile references group page: (Output File Strategy "modules") (Option Group "1") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -1135,7 +1135,7 @@ Renames and re-exports [defaultFunction](has-references.md#defaultfunction)
 `;
 
 exports[`Groups should compile references group page: (Output File Strategy "modules") (Option Group "2") 1`] = `
-"[typedoc-stubs](index.md) • Docs
+"[**typedoc-stubs**](index.md) • **Docs**
 
 ***
 
@@ -1176,7 +1176,7 @@ Renames and re-exports [defaultFunction](has-references.md#defaultfunction)
 `;
 
 exports[`Groups should compile references index page: (Output File Strategy "members") (Option Group "1") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***
 
@@ -1213,7 +1213,7 @@ Renames and re-exports [defaultFunction](functions/defaultFunction.md)
 `;
 
 exports[`Groups should compile references index page: (Output File Strategy "members") (Option Group "2") 1`] = `
-"[typedoc-stubs](../index.md) • Docs
+"[**typedoc-stubs**](../index.md) • **Docs**
 
 ***