@diglot/comark

中文文档
0.2.2发布于 2026/11/08MITTypeScriptES Module构建来源已验证近 30 天下载 3642

diglot 的comar 适配器

中文使用文档

@ diglot/ 标记

标记 用于 挖掘机:从comark文档中取出段并应用翻译.

pnpm add @diglot/comark @diglot/core

使用量

import { apply, extract, parse, render } from '@diglot/comark'

const doc = await parse(markdown)
const { segments } = await extract(doc, { file: 'docs/intro.md' })

const translations = new Map([[segments[0].hash, 'Introduction']])
const { doc: translated, report } = await apply(doc, translations)
// report: { applied, missing, rejected }

const output = await render(translated)
  • parse(source) 描述适配器所期望的选项并保留源和顶级行范围,因此保护的跨度(内置代码,链接,组件,内置HTML)从源头逐字取出. 在别处解析的文件也正常工作;其受保护的间隔被重新解析.

  • extract(doc, { file, policy }) 返回标题、段落、列表项、表格单元格、块引文、组件槽、图像选择、允许列表的道具、道具前题、代码标签和代码注释.

  • extract(doc, { spanSources: false }) 跳过切片并重交保护跨度。 链接、内置代码、图像、组件和内置的 HTML 在其占位符中获得空标记下移,从而改变每个部分的 text 财务报告和审定财务报表 sourceHash· ; hash, (中文(简体) ), skeleton,占位符类型和 words 都一样 在需要身份时使用它 就像需要一份清单一样.

  • apply(doc, translations, { policy }) 返回已翻译的副本。 每个翻译都是对照当前源片段验证的;占位符被填充当前源节点,因此链接,代码和组件总是来自源. 被拒绝和缺失的片段保留源文本 。 头号身份被保留。 代码注释在代码文本中被替换,包括已经被分解为突出显示跨度的代码.

  • apply(doc, translations, { onSegment }) 电话 onSegment 带有 ApplySegmentEvent 每个段. target.setAttribute(name, value) 在文本块上设置一个控住段的道具(h1 改为 h6, (中文(简体) ), p, (中文(简体) ), li, (中文(简体) ), blockquote, (中文(简体) ), th, (中文(简体) ), td) (中文(简体) ). 直接在元件内的文字被包入一个 span 带有属性的;在没有设置属性时,它将被保留。 前题、道具、图像选择、代码标签和代码注释都有 null 目标。 解决了Span源 onSegment 只通过; 通过 spanSources: false 当召喚不诵读的时候hash, (中文(简体) ), words 财务报告和审定财务报表 skeleton 不受影响.

    const events: ApplySegmentEvent[] = []
    const { doc: translated } = await apply(doc, segment => records.get(segment.hash), {
      onSegment(event) {
        events.push(event)
        if (event.outcome === 'missing' || event.outcome === 'rejected')
          event.target?.setAttribute('lang', 'en')
      },
    })
    const coverage = wordsByStatus(events)
    
  • apply(doc, translations, { copy: false }) 翻译 doc 而不是拷贝。 等别的事解决了再用 doc,例如为此项请求解析的文件.

  • render(doc) 写下标记, 硬折叠为 :br 并绑定 HTML 属性, 如 :zoom="false" 完好无损.

  • extractNavigation(source) 财务报告和审定财务报表 applyNavigation(source, translations) 控件 .navigation.yml 文档.

  • labelSegment(value, { kind, file, detail, policy }) 构建一个标签的段,散列为 extractNavigation 散开 .navigation.yml 价值(%s 是占位符)或者,与 kind: 'frontmatter',作为 extract 拥有一个前题值. translateLabel(value, translations, options) 返回其翻译,或 value 没有有效的。 用来翻译导航树和 titleTemplate运行时 s; 通过相同的 file, (中文(简体) ), detail 财务报告和审定财务报表 policy 当保险单有时作为提取 salt。 。 。 .

版本与发布记录

@diglot/comark 共发布 10 个版本,首次发布于 2026/11/03;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.2latest2026/11/083 天前
0.2.12026/11/066 天前
0.2.02026/11/057 天前
0.1.42026/11/048 天前
0.1.32026/11/038 天前
0.1.22026/11/039 天前

关于 @diglot/comark 的常见问题

@diglot/comark 是什么?

diglot 的comar 适配器

如何安装 @diglot/comark?

在项目目录运行 npm install @diglot/comark,或使用 pnpm add / yarn add / bun add。

@diglot/comark 支持 TypeScript 吗?

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

@diglot/comark 支持 ESM 还是 CommonJS?

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

@diglot/comark 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@diglot/comark 可以商用吗?

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

@diglot/comark 的下载量有多少?

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

@diglot/comark 还在维护吗?

最新版本 0.2.2 发布于 2026/11/08(3 天前);至今共发布 10 个版本,其中过去 12 个月发布了 10 个;首次发布于 2026/11/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。