介绍 GGM

简介

GGM 是一个轻量级的 GitHub Markdown 语法解析器，可以将 GitHub Markdown 语法转换为 HTML、LaTeX 等格式。GGM 支持大部分 GitHub Markdown 语法，并且易于构建和使用。

功能特性

• 支持 GitHub Markdown 的大部分语法
• 支持自定义语法扩展
• 支持多种输出格式，包括 HTML、LaTeX 等
• 易于构建和使用

安装

你可以通过 npm 或者 yarn 安装 GGM：

npm install ggm

或者

yarn add ggm

使用

GGM 的使用非常简单，只需要调用 parse 方法即可：

const { parse } = require('ggm');

const markdown = '# Hello, World!';

const html = parse(markdown);

console.log(html);
// <h1>Hello, World!</h1>

GGM 还支持自定义语法扩展，示例：

const { parse } = require('ggm');

const markdown = '{note} This is a note. {/note}';

const html = parse(markdown, {
  rules: {
    note: (content) => `<div class="note">${content}</div>`
  }
});

console.log(html);
// <div class="note"> This is a note. </div>

输出格式

GGM 支持以下输出格式：

• HTML（默认）
• LaTeX

你可以使用 options.outputFormat 选项指定输出格式：

const { parse } = require('ggm');

const markdown = '# Hello, World!';

const latex = parse(markdown, {
  outputFormat: 'latex'
});

console.log(latex);
// \section{Hello, World!}

API 文档

你可以参考 API 文档 了解 GGM 的详细使用方法。

贡献

如果你发现了 GGM 的问题或者想要贡献代码，欢迎提交 Issue 或者 Pull Request。