# @covalent/markdown 中文文档

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

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

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

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

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

- 包体积（解压后）：214 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：showdown ^2\.1\.0，@angular/core 20\.x\.x，@angular/common 20\.x\.x，@angular/platform-browser 20\.x\.x
- 首次发布：2016-07-12T23:23:08.065Z
- 最新版本发布：2026-10-02T15:28:27.064Z
- 近 30 天下载量：4654（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：440（近 12 个月 74 个）

## 中文简介

Teradata UI 平台标记下模块

## 安装

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

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

## README

## TdMarkdown 组件: td- 标记下

`<td-markdown>` 是一个能解析和使Github的口味降低的组件。 它基于 [显示](https://github.com/showdownjs/showdown/) 图书馆.

**说明:** 此模块使用 **多明我会** 将 解析出 html 从 showdown lib 中进行消毒服务以避免 **预算外** 问题.

默认, `--dev` 构建将会在控制台上登录以下信息, 以便让您知道 :

`WARNING: sanitizing HTML stripped some content (see http://g.co/ng/security#xss).`

## API 总结

#### 投入

-   内容 ?: 字符串
    
    -   将下调格式内容解析为 html 标记 .
    -   用来动态地加载数据. 譬如说. `README.md` 内容.
-   简单线断层 ?: 字符串
    
    -   设定段落和跨度内的新行字符解析为  
        。 。 。 .
    -   默认为假.
-   主机Url : 字符串
    
    -   如果标记下包含相对路径,则需要这样做以生成正确的urls.
-   锁定 ?: 字符串
    
    -   跳来跳去.
-   文件链接扩展?: 字符串 \[\]
    
    -   要监视锚标记内的文件扩展名 .
    -   点击以这些扩展结尾的链接会防止默认动作并发出"fileClicked"事件 .

#### 活动

-   内容已读取: 未定义
    
    -   标定内容渲染完成后释放的事件 .
-   文件已点击: URL
    
    -   当锁定标签被点击, 而其“ href” 匹配“ fileLinkExtensions” 中的扩展名时, 发送 .

## 安装

此组件可以作为npm包安装.

```bash
npm i -save @covalent/markdown
```

## 设置

然后导入 **共价马克下架模块** 在您的 NGMudule 中:

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

### 他们

这个模块带有它自己的共价主题,它使用的材料主题用于导入我们的主题 scs 文件.

```scss
@use '@angular/material/theming' as mat;
@use '@covalent/markdown/markdown-theme' as markdown;

@include mat.core();

$primary: mat.define-palette($mat-orange, 800);
$accent: mat.define-palette($mat-light-blue, 600, A100, A400);
$warn: mat.define-palette($mat-red, 600);

$theme: mat.define-light-theme($primary, $accent, $warn);

@include markdown.covalent-markdown-theme($theme);
```

## 示例

**Html : (英语)**

```html
<td-markdown> # Heading ## Sub Heading (H2) ### Steps (H2) </td-markdown>
```

**输出 :**

# 标题

## 分标题(H2)

### 步骤(H2)

## 常见问题

### @covalent/markdown 是什么？

Teradata UI 平台标记下模块

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

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

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

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

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

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

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

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

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

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

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

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