Kramed 开源项目教程

惠进钰

于 2024-08-15 09:42:35 发布

阅读量888

点赞数 17

本文链接：https://blog.csdn.net/gitblog_00105/article/details/141210702

版权

Kramed 开源项目教程

kramedA markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)项目地址:https://gitcode.com/gh_mirrors/kr/kramed

项目介绍

Kramed 是一个基于 kramed 引擎的 Markdown 渲染器，它是 hexo-renderer-marked 的一个分支。Kramed 旨在提供更强大的 MathJax 支持，并且更接近于 kramdown 标准。它实现了所有的 Markdown 特性，并且通过了官方 Markdown 测试套件的全面测试。

项目快速启动

安装 Kramed

首先，你需要通过 npm 安装 Kramed：

npm install kramed

基本使用

以下是一个简单的示例，展示如何使用 Kramed 渲染 Markdown 文本：

var kramed = require('kramed');
console.log(kramed('I am using __markdown__.'));
// 输出: <p>I am using <strong>markdown</strong>.</p>

设置选项

你可以通过 setOptions 方法设置 Kramed 的选项：

var kramed = require('kramed');
kramed.setOptions({
  renderer: new kramed.Renderer(),
  gfm: true,
  tables: true,
  breaks: false,
  pedantic: false,
  sanitize: true,
  smartLists: true,
  smartypants: false
});
console.log(kramed('I am using __markdown__.'));

应用案例和最佳实践

数学公式支持

Kramed 特别强调对 MathJax 的支持，以下是一个包含数学公式的示例：

var kramed = require('kramed');
var markdownWithMath = '$\sigma$ is a symbol in math.';
console.log(kramed(markdownWithMath));
// 输出: <p><span class="math">\sigma</span> is a symbol in math.</p>

自定义渲染器

你可以通过自定义渲染器来扩展 Kramed 的功能：

var kramed = require('kramed');
var renderer = new kramed.Renderer();
renderer.paragraph = function(text) {
  return '<p class="custom-paragraph">' + text + '</p>';
};
kramed.setOptions({ renderer: renderer });
console.log(kramed('I am using __markdown__.'));

典型生态项目

Hexo 渲染器

Kramed 最初是作为 Hexo 的一个渲染器开发的，用于替代 hexo-renderer-marked，以提供更好的 MathJax 支持。如果你正在使用 Hexo，可以考虑使用 Kramed 作为你的 Markdown 渲染器。

客户端渲染

Kramed 也支持在客户端进行渲染，这使得它非常适合用于需要动态渲染 Markdown 的 Web 应用。以下是一个简单的客户端示例：

<!DOCTYPE html>
<html>
<head>
  <script src="kramed.min.js"></script>
</head>
<body>
  <div id="content"></div>
  <script>
    var markdownText = 'I am using __markdown__.';
    document.getElementById('content').innerHTML = kramed(markdownText);
  </script>
</body>
</html>

通过这些示例和实践，你可以更好地理解和使用 Kramed 开源项目。

kramedA markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)项目地址:https://gitcode.com/gh_mirrors/kr/kramed

惠进钰

关注

17
点赞
踩
11

收藏

觉得还不错? 一键收藏
打赏
0
评论
Kramed 开源项目教程

Kramed 开源项目教程 kramedA markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)项目地址:https://gitcode.com/gh_mirrors/kr/kramed 项目介绍Kramed 是一个基于 kramed 引擎的 Markdown 渲染器，它是 h...
复制链接

扫一扫