@comark/ ansi (英语)
ANSI 终端渲染器 标记. Render markdown 作为CLI,脚本和开发者工具的样式终端输出.
特征
- 终端的 ANSI 类输出
- 🌈 尊重
NO_COLOR自动 - HR 和代码块的可配置终端宽度
- 将任何 Comark 标记映射到自定义渲染函数
- QQ 插件生态系统( 美人鱼、 突出、 绑定... )
- QQ 全类型脚本支持
安装
npm install @comark/ansi
# or
pnpm add @comark/ansi
使用量
import { renderAnsi } from '@comark/ansi'
const output = await renderAnsi(`
# Getting Started
This is a **bold** statement with a [link](https://example.com).
- Item 1
- Item 2
`)
process.stdout.write(output)
选项
await renderAnsi(content, {
colors: true, // emit ANSI escape codes (defaults to true, false when NO_COLOR is set)
width: 80, // terminal width for HR and code block headers
plugins: [],
components: {},
})
语法突出显示
import { renderAnsi } from '@comark/ansi'
import shiki from '@comark/ansi/plugins/shiki'
const output = await renderAnsi('```ts\nconsole.log("hi")\n```', {
plugins: [shiki()],
})
API 密码
renderAnsi(markdown, options?)解析并让 Markdown 变成 ANSI 字符串 .createAnsiRenderer(options?)创建可重复使用的剖析和递归函数.renderAnsiFromDocument(document, options?)使预分解MarkdownDocument。 。 。 .printAnsi(markdown, options?)解析并写入 Markdown 到process.stdout或习惯writer. (中文(简体) )writeAnsi是被贬损的别名。 )createAnsiPrinter(options?)创建可重复使用的打印机 。 ()createAnsiWriter是被贬损的别名。 )
import { createAnsiPrinter } from '@comark/ansi'
const printAnsi = createAnsiPrinter({
colors: false,
writer: (output) => process.stderr.write(output),
})
await printAnsi('# Build complete')
文档
完整指南和 API 参考 comark.dev/refersing/ansi(签名)。 。 。 .
许可证
由 所制
原载 MIT 许可证。 。 。 .