轻量级JavaScript Markdown渲染器，接近GitHub风格的高兼容性

仅3KB极轻量
XSS安全保障
零依赖设计
GitHub仓库 NPM包

核心功能

极致的轻量

  • 核心代码仅约3KB
  • Brotli压缩后低至1.5KB
  • 零依赖，纯原生JavaScript实现
  • 加载迅速，完美适合前端项目

GFM高兼容

  • 支持GitHub Flavored Markdown规范
  • 完美渲染表格、任务列表等高级元素
  • 自动链接检测
  • 行内代码和代码块高亮支持

安全可靠

  • 内置XSS安全防护
  • 默认转义HTML标签
  • 提供安全的unsafe模式可选
  • 严谨的输入处理机制

快速开始

将MiniGFM集成到您的项目中只需几步：

CDN方式
NPM方式

在HTML中通过CDN引入：

HTML 
<script src="https://cdn.jsdelivr.net/npm/@oblivionocean/minigfm@latest/dist/index.min.js"></script>

通过NPM安装：

终端 
npm install @oblivionocean/minigfm

在项目中使用：

JavaScript 
// 使用ESModule导入
import MiniGFM from '@oblivionocean/minigfm';

// 使用CommonJS导入
const MiniGFM = require('@oblivionocean/minigfm').MiniGFM;

// 创建实例并解析Markdown
const md = new MiniGFM();
console.log(md.parse('# Hello World')); // <h1>Hello World</h1>

在线演示

Markdown输入
渲染结果

配置选项

MiniGFM提供了灵活的配置选项，满足您的个性化需求。

属性 类型 默认值 描述
unsafe boolean false 允许原始HTML标签 (启用后请注意XSS风险)
hljs object null 启用代码高亮，传入highlight.js实例

配置示例

JavaScript 
// 创建配置实例
const md = new MiniGFM({
    unsafe: true, // 允许原始HTML渲染
    hljs: hljs,   // 使用highlight.js处理代码块
});

// 解析Markdown
const html = md.parse('# Hello World'); 
console.log(html); // <h1>Hello World</h1>