# @covalent/markdown-navigator 中文文档

规范地址：https://npmcn.com/package/%40covalent/markdown-navigator/

版本：11\.23\.0
npm 元数据更新时间：2026-10-02T15:29:00.835Z
中文译文更新时间：2026-11-11T00:53:37.022Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40covalent/markdown-navigator
原文对照：https://npmcn.com/package/%40covalent/markdown-navigator/?lang=original
项目主页：https://github.com/teradata/covalent#readme
源码仓库：https://github.com/teradata/covalent

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：245 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/cdk 20\.x\.x，@angular/core 20\.x\.x，@covalent/core 11\.23\.0，@angular/common 20\.x\.x，@angular/material 20\.x\.x，@covalent/highlight 11\.23\.0，@covalent/flavored-markdown 11\.23\.0
- 首次发布：2019-10-05T00:49:48.173Z
- 最新版本发布：2026-10-02T15:29:00.674Z
- 近 30 天下载量：2361（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：391（近 12 个月 74 个）

## 中文简介

Teradata UI 平台标记下导航模块

## 安装

```sh
npm install @covalent/markdown-navigator
```

也可以使用：`pnpm add @covalent/markdown-navigator`、`yarn add @covalent/markdown-navigator`、`bun add @covalent/markdown-navigator`

## README

# 马克下纳维加多组件

用于渲染和导航的组件,通过标记下,例如文件. 支持github urls. (英语).

## API 总结

#### 投入

-   项目: IMarkdownNavigator 项目\[
    -   IMarkdown Navigator 列表 将要提供的项目
-   标签 ?: IMarkdownNavigator标签
    -   翻译标签
-   启动 At ? : IMarkdownNavigator 项目 : IMarkdownNavigator 项目 \[\]
    -   跳转到的项目或路径
-   比较一下
    -   用于找到启动项的函数
    -   严格平等比较的默认值(XQ)
-   脚步: 类型
    -   自定义组件用作全局页脚
-   复制CodeToC剪贴板吗 : 布尔
    -   在代码片断上显示复制按钮以复制代码到剪贴板.
-   复制 CodeTooltips ?: ICopyCodeTooltips
    -   要复制和复制的工具提示 .

#### 产出

-   按钮被点击 :
    -   单击按钮时发出
-   选中的项目: IMarkdownNavigator 项目
    -   选定项目时发送选中的项目

供参考:

```typescript
interface IMarkdownNavigatorItem {
  id?: string; // used to compare items by default and as attr id for content
  title?: string;
  url?: string;
  httpOptions?: object;
  markdownString?: string; // raw markdown
  anchor?: string;
  children?: IMarkdownNavigatorItem[];
  childrenUrl?: string;
  description?: string;
  icon?: string;
  footer?: Type<any>;
}

interface ICopyCodeTooltips {
  copy?: string;
  copied?: string;
}
```

## 设置

```typescript
import { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';
@NgModule({
  imports: [CovalentMarkdownNavigatorModule],
})
export class MyModule {}
```

## 共价图标支持( 选项)

Markdown导航器会自动检测Covalent图标并应用正确的字体样式. 共价图标为 **完全可选** - 组件仅与材料图标完美地工作.

### 图标检测( 构建)

该组件包括图标检测出箱. **不需要额外的设置或安装.**

图标检测被捆绑在组件中,并与任何版本的 `@covalent/icons` 安装在您的工程中.

### 渲染共价图标( 可选)

如果你想的话 **提交** 共价图标(不仅仅是材料图标),您需要安装图标字体 :

**备选案文1:使用共价设计系统**

如果您的工程已经使用其他共价组件, 其全局样式如下 :

```scss
@use '@covalent/icons';
```

共价图标将自动工作 .

**备选案文2:单独安装**

1.  **安装图标包 :**
    
    ```bash
    npm install @covalent/icons
    ```
    
2.  **导入您的全局样式** (单位:千美元)`src/styles.scss`:
    
    ```scss
    @import '@covalent/markdown-navigator/styles/markdown-navigator-icons.scss';
    ```
    

### 图标使用

两种图标类型在您的数据中工作方式相同 :

```typescript
// Material Icons (always available via Google Fonts)
{
  title: 'Notebooks',
  icon: 'book',
}

// Covalent Icons (requires @covalent/icons for rendering)
{
  title: 'Vector Store',
  icon: 'variable_outlined',  // Auto-detected as Covalent icon
}
```

**说明:** 如果使用共价图标, 但是 `@covalent/icons` 未安装,图标将显示为空框。 材料图标总是在不附加设置的情况下工作.

组件自动检测根据图标名称使用的字体。 在您的 TypeScript 代码中不需要额外的配置 .

## 使用量

```html
<td-markdown-navigator [items]="items"></td-markdown-navigator>
```

```typescript
const items = [
  {
    id: 'covalent',
    title: 'Covalent',
    children: [
      {
        id: 'component',
        title: 'Components',
        children: [
          {
            id: 'td-loading',
            url: 'https://raw.githubusercontent.com/Teradata/covalent/main/src/platform/core/loading/README.md',
            title: 'tdLoading',
          },
        ],
      },
    ],
  },
];
```

# 马克下纳维加多窗口组件

包含 MarkdownNavigator 组件和工具栏的组件

## API 总结

#### 投入

-   项目: IMarkdownNavigator 项目\[
    -   IMarkdown Navigator 列表 将要提供的项目
-   标签 ?: IMarkdownNavigator标签
    -   翻译标签
-   启动 At ? : IMarkdownNavigator 项目 : IMarkdownNavigator 项目 \[\]
    -   跳转到的项目或路径
-   比较一下
    -   用于找到启动项的函数
    -   严格平等比较的默认值(XQ)
-   工具栏颜色 ?: 主题Palette
    -   工具栏颜色
    -   默认为“ 主要 ”
-   脚步: 类型;
    -   自定义组件用作全局页脚

#### 产出

-   关闭: 无效
    -   点击关闭按钮时事件已释放 .
-   按钮被点击 :
    -   单击按钮时发出
-   选中的项目: IMarkdownNavigator 项目
    -   选定项目时发送选中的项目

## 设置

```typescript
import { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';
@NgModule({
  imports: [CovalentMarkdownNavigatorModule],
})
export class MyModule {}
```

## 使用量

```html
<td-markdown-navigator-window [items]="items"></td-markdown-navigator-window>
```

# MarkdownNavigator Window服务公司

在可拖动对话框中打开 MarkdownNavigator WindowComponent 的服务 。 使用 TdDialog Service 的可打开Draggic 方法.

## API 总结

#### 方法

-   打开: 函数( 配置: IMarkdownNavigator Window Config)
    -   在可拖动的对话框中打开 MarkdownNavigator Window 组件 .

供参考:

```typescript
interface IMarkdownNavigatorWindowConfig {
  items: IMarkdownNavigatorItem[];
  dialogConfig?: MatDialogConfig;
  labels?: IMarkdownNavigatorWindowLabels;
  toolbarColor?: ThemePalette;
  startAt?: IMarkdownNavigatorItem | IMarkdownNavigatorItem[];
  compareWith?: IMarkdownNavigatorCompareWith;
  footer?: Type<any>;
}
```

## 设置

```typescript
import { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';
@NgModule({
  imports: [CovalentMarkdownNavigatorModule],
})
export class MyModule {}
```

## 使用量

```typescript
import { TdMarkdownNavigatorWindowComponent, TdMarkdownNavigatorWindowService, IMarkdownNavigatorItem } from '@covalent/markdown-navigator';
import { MatDialogRef } from '@angular/material/dialog';

export class SampleComponent {
  constructor(private _markdownNavigatorWindowService: TdMarkdownNavigatorWindowService) {}

  ngOnInit(): void {
    const ref: MatDialogRef<TdMarkdownNavigatorWindowComponent> = this._markdownNavigatorWindowService.open({
      items: [
        {
          url: 'https://github.com/Teradata/covalent/blob/main/README.md',
        },
      ],
    });
    ref.afterOpened().subscribe(() => {});
    ref.afterClosed().subscribe(() => {});
  }
}
```

# 马克下纳维加多窗口指令

使用 Td- MarkdownNavigator Window Service 在点击事件上打开方法的命令 .

## API 总结

#### 投入

-   (原始内容存档于2018-10-21) (英语). MarkdownNavigator Window: IMarkdownNavigator Window Config
    -   要打开窗口的配置
-   禁用:布尔
    -   无论是否禁用

## 设置

```typescript
import { CovalentMarkdownNavigatorModule } from '@covalent/markdown-navigator';
@NgModule({
  imports: [CovalentMarkdownNavigatorModule],
})
export class MyModule {}
```

## 使用量

示例

```html
<button mat-button [tdMarkdownNavigatorWindow]="{ items: [] }" [disabled]="false">Open window</button>
```

## 常见问题

### @covalent/markdown-navigator 是什么？

Teradata UI 平台标记下导航模块

### 如何安装 @covalent/markdown-navigator？

在项目目录运行 npm install @covalent/markdown-navigator，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/cdk（20\.x\.x）、@angular/core（20\.x\.x）、@covalent/core（11\.23\.0）、@angular/common（20\.x\.x）、@angular/material（20\.x\.x）、@covalent/highlight（11\.23\.0）、@covalent/flavored-markdown（11\.23\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @covalent/markdown-navigator 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @covalent/markdown-navigator 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @covalent/markdown-navigator 可以商用吗？

@covalent/markdown-navigator 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @covalent/markdown-navigator 的下载量有多少？

根据 npm 官方下载统计，@covalent/markdown-navigator 在 2026/10/11 – 2026/11/09 这 30 天内被下载 2,361 次，日均约 79 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @covalent/markdown-navigator 还在维护吗？

最新版本 11\.23\.0 发布于 2026/10/02（1 个月前）；至今共发布 391 个版本，其中过去 12 个月发布了 74 个；首次发布于 2019/10/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。