# @foblex/m-render 中文文档

规范地址：https://npmcn.com/package/%40foblex/m-render/

版本：4\.0\.2
npm 元数据更新时间：2026-03-19T12:50:13.398Z
中文译文更新时间：2026-11-15T04:17:52.266Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.1 MB，26 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@angular/common \>=12\.0\.0，@angular/core \>=12\.0\.0，@angular/cdk \>=12\.0\.0，markdown-it \>=14\.1\.0，markdown-it-container \>=4\.0\.0，shiki ^3\.4\.2
- 首次发布：2024-12-31T10:57:32.892Z
- 最新版本发布：2026-03-19T12:50:13.278Z
- 近 30 天下载量：2389（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 7 个）

## 中文简介

MRender是一个静态站点生成器,旨在基于Markdown文件创建快速而方便用户的文档站点. MarkEngine支持扩展的Markdown语法,并且可以直接从Markdown文件中渲染Angular组件.

## 安装

```sh
npm install @foblex/m-render
```

也可以使用：`pnpm add @foblex/m-render`、`yarn add @foblex/m-render`、`bun add @foblex/m-render`

## README

# MRENDER: Angular 的标记下渲染器

**微镜** 是一个Angular 库,用于在 SSR 支持下渲染基于 Markdown 的文档,内置 Angular 组件,可自定义的 UI,以及扩展的语法.

* * *

## \* 特性

-   渲染器 `.md` 在 Angular 应用程序中的文件
-   扩展语法 : `ng-component`, (中文(简体) ), `code-group`, (中文(简体) ), `preview-group`,警报块(`tip`, (中文(简体) ), `info`, (中文(简体) ), `danger`页:1
-   与安全部门改革完全兼容
-   将角构件嵌入下标
-   以供应商为基础的主页和文件配置
-   粗略地加载实例
-   内建目录、 SIO 和元支持

* * *

## \* 安装

```bash
npm install @foblex/m-render
```

* * *

## 使用量

### 主页配置

```ts
import {
  provideBackground, provideComponents,
  provideHero, provideHomeButtons, provideHomeFeatures,
  provideHomeFooter, provideImage, provideLogo, provideTitle
} from '@foblex/m-render';

export const HOME_CONFIGURATION = {
  providers: [
    provideLogo('./logo.svg'),
    provideTitle('Foblex Flow'),
    provideHero({
      headline: 'Foblex Flow',
      tagline1: 'Built with Angular',
      tagline2: 'Flow-Chart Library',
      subDescription: 'Supports Angular 12+, SSR, and Composition API.',
    }),
    provideBackground(HomePageBackgroundComponent),
    provideImage(HomePageImageComponent),
    provideHomeButtons([...]),
    provideHomeFeatures([...]),
    provideHomeFooter({ text: 'MIT License | Copyright © 2022 - Present' }),
  ],
};
```

### 文件配置

```ts
import {
  provideDirectory, provideNavigation, provideComponents,
  provideTableOfContent, provideHeader, provideFooterNavigation,
  provideMeta
} from '@foblex/m-render';

export const DOCUMENTATION_CONFIGURATION = {
  providers: [
    provideDirectory('./markdown/guides/'),
    provideNavigation(...),
    provideComponents([...]),
    provideTableOfContent({ title: 'In this article', range: { start: 2, end: 6 } }),
    provideHeader(...),
    provideFooterNavigation(...),
    provideMeta({ ... }),
  ],
};
```

### 路由设置

```ts
import { provideDocumentation, provideHomePage } from '@foblex/m-render';

export const routes: Routes = [
  {
    path: '',
    loadChildren: () => import('@foblex/m-render').then((m) =>
      m.HOME_ROUTES.map((route) => ({
        ...route,
        providers: [provideHomePage(HOME_CONFIGURATION)],
      }))
    ),
  },
  {
    path: 'docs',
    loadChildren: () => import('@foblex/m-render').then((m) =>
      m.DOCUMENTATION_ROUTES.map((route) => ({
        ...route,
        providers: [provideDocumentation(DOCUMENTATION_CONFIGURATION)],
      }))
    ),
  },
];
```

* * *

## ++ 标记下扩展

### `ng-component`

Render 角组件或外部 URL( 通过 `iframe`)带有可选的高度和链接源代码:

```markdown
::: ng-component <component-selector></component-selector> [height]="YOUR EXAMPLE HEIGHT"
[component.ts] <<< /assets/component.ts
[component.html] <<< /assets/component.html
:::
```

```markdown
::: ng-component [url]="https://example.com" [height]="60vh"
[component.ts] <<< /assets/component.ts
:::
```

`ng-component` 支持全屏模式出框,用于角预览和iframe预览.

### `code-group`

将多个代码片段组合成标签 :

````markdown
::: code-group
```ts [Component]
console.log('Component code');
```

```html [Template]
<div>Hello</div>
```
:::
````

### `preview-group`

以过滤器显示预览组 :

```markdown
::: preview-group
[Nodes]
[Connectors]
[Connections]
:::
```

### 警报

使用 `tip`, (中文(简体) ), `danger`, (中文(简体) ), `info`等 :

```markdown
::: tip Title
This is a tip block
:::
```

* * *

## 捐款

开放捐款、反馈和公关.

GitHub : (中文(简体) ) [https://github.com/Foblex/m-render (英语)](https://github.com/Foblex/m-render)

* * *

## 许可证

[麻省理工学院](https://npmcn.com/package/%40foblex/m-render/LICENSE)

* * *

## 灵感

MRender的设计和布局受到很大启发 [虚拟新闻](https://vitepress.dev/)由Evan You为Vue制作的开源静态站点生成器.  
MRender在Angular是完全的再执行,但其UI和结构有意地跟随VitePress的熟悉和清晰.

## 常见问题

### @foblex/m-render 是什么？

MRender是一个静态站点生成器,旨在基于Markdown文件创建快速而方便用户的文档站点\. MarkEngine支持扩展的Markdown语法,并且可以直接从Markdown文件中渲染Angular组件\.

### 如何安装 @foblex/m-render？

在项目目录运行 npm install @foblex/m-render，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@angular/common（\>=12\.0\.0）、@angular/core（\>=12\.0\.0）、@angular/cdk（\>=12\.0\.0）、markdown-it（\>=14\.1\.0）、markdown-it-container（\>=4\.0\.0）、shiki（^3\.4\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @foblex/m-render 支持 TypeScript 吗？

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

### @foblex/m-render 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @foblex/m-render 可以商用吗？

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

### @foblex/m-render 的下载量有多少？

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

### @foblex/m-render 还在维护吗？

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