首页
/ Transmuter 技术文档

Transmuter 技术文档

2024-12-26 13:00:07作者:平淮齐Percy

1. 安装指南

首先,确保您的系统中已经安装了Ruby环境。接下来,您可以通过以下命令安装Transmuter工具:

$ gem install transmuter

Transmuter依赖于pygments.rb,因此还需要安装Python的Pygments库。您可以使用以下命令进行安装:

$ sudo easy_install pygments

对于使用Debian或Gentoo Linux发行版的用户,也可以通过包管理器进行安装。例如,在Ubuntu系统中:

$ sudo aptitude install python-pygments

另外,Transmuter还依赖于PDFkit,这需要安装WKHTMLTOPDF。关于WKHTMLTOPDF的安装说明,请参考PDFKit项目的GitHub页面。

2. 项目使用说明

使用Transmuter之前,可以通过以下命令查看帮助信息:

$ transmute --help

以下是一些使用示例:

  • 从Markdown文件生成PDF(默认CSS):
$ transmute file.md
  • 从Markdown文件生成HTML(默认CSS):
$ transmute file.md -t html
  • 从Markdown文件生成HTML(自定义CSS):
$ transmute file.md -t html -s custom.css
  • 从Markdown文件生成HTML(多个自定义CSS文件):
$ transmute file.md -t html -s custom1.css custom2.css

3. 项目API使用文档

Transmuter作为一个命令行工具,不提供传统意义上的API接口。它的使用方式主要通过命令行参数来指定输入文件、输出格式以及样式文件等。

4. 项目安装方式

如前所述,Transmuter的安装方式主要是通过Ruby的gem包管理器进行。以下是安装步骤:

$ gem install transmuter

在安装过程中,请确保您的系统已经安装了所有必要的依赖项,包括Python的Pygments库和WKHTMLTOPDF。

登录后查看全文
热门项目推荐