创建- markdown/ 核心
以块为主的标记下分解和序列化,零依赖.
安装
# Using pnpm
pnpm add @create-markdown/core
# Using npm
npm install @create-markdown/core
# Using yarn
yarn add @create-markdown/core
# Using pnpm
pnpm add @create-markdown/core
快速启动
将下划为块
import { parse } from '@create-markdown/core';
const blocks = parse(`# Hello World
This is **bold** and *italic* text.
- Item one
- Item two
`);
程序创建块
import { h1, paragraph, bulletList, bold, italic, spans } from '@create-markdown/core';
const blocks = [
h1('My Document'),
paragraph(spans(
bold('Important: '),
{ text: 'This is ', styles: {} },
italic('really'),
{ text: ' cool!', styles: {} }
)),
bulletList(['First item', 'Second item', 'Third item']),
];
将块序列化到 Markdown
import { stringify, h1, paragraph, codeBlock } from '@create-markdown/core';
const markdown = stringify([
h1('Hello'),
paragraph('World'),
codeBlock('console.log("Hi!");', 'javascript'),
]);
块类型
| 类型 | 工厂函数 | 说明 |
|---|---|---|
paragraph | paragraph(content) | 文本段落 |
heading | heading(level, content) 或者说 h1- 说吧h6 | 标题 |
bulletList | bulletList(items) | 无序列表 |
numberedList | numberedList(items) | 排序列表 |
checkList | checkList(items) | 带有复选框的任务列表 |
codeBlock | codeBlock(code, language?) | 栅栏码块 |
blockquote | blockquote(content) | 块引号 |
image | image(url, alt?) | 图像 |
divider | divider() | 水平规则 |
table | table(headers, rows) | 有信头的表格 |
callout | callout(type, content) | 点名/宣传 |
API 参考
分析
parse(markdown)- 将标记字符串分析成块markdownToBlocks(markdown, options?)- 有选项的全解析器markdownToDocument(markdown)- 分析文档对象
序列化
stringify(blocks)- 将区块序列化以标记下blocksToMarkdown(blocks, options?)- 带选项的全序列器documentToMarkdown(doc)- 将文档序列化
文件操作
createDocument(blocks?, options?)- 创建一个新文档insertBlock(doc, block, index?)- 在位置上插入块appendBlock(doc, block)- 在末尾添加块removeBlock(doc, blockId)- 通过ID删除块updateBlock(doc, blockId, updates)- 更新块属性moveBlock(doc, blockId, newIndex)- 重排区块findBlock(doc, blockId)- 以身份证查找块
许可证
麻省理工学院