kramdown 文档

Author Avatar
lsbbd 9月 01, 2016
  • 在其它设备中阅读本文章

概述

kramdown 是第一个将 Markdown 的超集转换为 HTML 的库,得益于其模块化的结构,可以为其添加额
外的输入和输出格式。目前支持的输入输出格式如下:

  • 输入:kramdown (一个 Markdown 的超集),Markdown,Github Flavored Markdown,
    HTML
  • 输出:HTML,LaTex,kramdown,RemoveHtmlTags (一个可将 HTML 标签移除的特殊转化器,
    通常配合 LaTex 或者 kramdown 转换器使用)

[kramdown 语法篇][syntax] 描述了 kramdown 的细节以及它与标准 Markdown 的不同之处。

要查看所有支持的参数请参考 [参数篇][options] 或者看一看 「解析器/转换器」 篇。

用法

kramdown 提供了两种使用方式:

作为库使用

kramdown 使用了与 RedCloth,BlueCloth 以及 Maruku 相同的 API:

1
2
3
require 'kramdown'
puts Kramdown::Document.new(text).to_html

作为应用使用

和库文件一起的一个叫 kramdown 二进制文件可用来将任何支持的输入格式转换为支持的格式输出。
输入既可以来自文件也可以是标准输入流。比如:

1
kramdown path/to/kramdown/doc/syntax.page

测试

kramdown 使用几种测试来验证解析器和转换器的正确性。详见 测试