Maruku 技术文档

本文档旨在帮助用户了解和安装 Maruku 项目，并提供使用说明及 API 使用文档。

安装指南

在安装 Maruku 之前，请确保您已经安装了 Ruby 和 RubyGems。然后运行以下命令安装 Maruku：

gem install maruku

使用说明

基本使用

要将 Markdown 转换为 HTML，首先创建一个新的文档对象，然后使用 to_html 方法获取其 HTML 表示形式：

doc = Maruku.new(markdown_string)
puts doc.to_html

#to_html 方法返回一个字符串，表示一个 HTML 片段。

例如：

Maruku.new("## Header ##").to_html
# => "<h2 id='header'>header</h2>"

如果您想创建完整的 HTML 文档，请使用 #to_html_document 方法。

错误管理

如果输入有误，Maruku 会发出警告。默认行为是在标准错误中打印警告，然后尝试继续执行。

此行为可以通过 :on_error 选项进行自定义。例如：

Maruku.new(string, :on_error => :raise)

这告诉 Maruku 在遇到解析错误时抛出异常。

要更改错误流，请使用 :error_stream 选项：

errors = "Errors reported by Maruku:\n"
Maruku.new(invalid, :error_stream => errors)

您可以传递任何支持 << 方法的对象。

命令行使用

Maruku 提供了两个命令行程序：maruku 和 marutex。

maruku 将 Markdown 转换为 HTML：

$ maruku file.md  # 创建 file.html

marutex 将 Markdown 转换为 LaTeX，然后调用 pdflatex 将 LaTeX 转换为 PDF：

$ marutex file.md  # 创建 file.tex 和 file.pdf

项目 API 使用文档

Maruku 的公共接口是 Maruku 类。以下是 Maruku 类的一些主要方法：

• new(markdown_string, [options]): 创建一个新的 Maruku 文档对象。
• to_html: 将 Markdown 转换为 HTML 片段。
• to_html_document: 将 Markdown 转换为完整的 HTML 文档。

项目安装方式

Maruku 可以通过 RubyGems 进行安装。确保已安装 Ruby 和 RubyGems，然后运行以下命令：

gem install maruku

以上就是关于 Maruku 项目的安装指南、使用说明和 API 使用文档。希望这些信息能够帮助您更好地了解和使用 Maruku。