Hammer.vim 技术文档

1. 安装指南

1.1 依赖安装

在使用 Hammer.vim 之前，您需要确保系统中安装了以下依赖：

• github-markup 和 tilt 这两个 Ruby gem。
• 根据您使用的标记语言，可能还需要安装额外的 gem 或工具。例如：
  • 使用 .markdown 需要 redcarpet gem。
  • 使用 .textile 需要 RedCloth gem。
  • 使用 .org 需要 org-ruby gem。
  • 使用 .creole 需要 creole gem。
  • 使用 .mediawiki 需要 wikicloth gem。
  • 使用 .rst 需要 docutils。
  • 使用 .asciidoc 需要 asciidoc。
  • 使用 .pod 需要 Pod::Simple::HTML（Perl >= 5.10）。
  • 使用 .1 需要 groff。

1.2 安装步骤

1. 安装所需的 Ruby gem：

   $ [sudo] gem install github-markup tilt
   

2. 克隆 Hammer.vim 项目：

   $ git clone git://github.com/matthias-guenther/hammer.vim.git
   

3. 将插件文件复制到 Vim 的插件目录：

   $ cp -R hammer.vim/plugin/* $HOME/.vim/plugin
   

1.3 RVM 用户注意事项

如果您使用 RVM，可能会遇到随机段错误。解决方法是定义一个 shell 函数，在启动 Vim 前取消 $GEM_HOME 和 $GEM_PATH 的设置：

mvim()
{
  (unset GEM_PATH GEM_HOME; command mvim "$@")
}

1.4 rbenv 用户注意事项

即使您设置了全局 Ruby，Vim 仍会使用系统 Ruby。确保在系统 Ruby 下安装所需的 gem：

$ rbenv shell system
$ [sudo] gem install github-markup tilt

2. 项目使用说明

2.1 基本使用

Hammer.vim 是一个 Vim 插件，主要用于将您选择的标记语言转换为 HTML，并在浏览器中打开生成的 HTML 文件。

在 Vim 中，使用以下命令启动 Hammer：

:Hammer

该命令会将当前文件转换为 HTML，并在默认浏览器中打开。

2.2 配置变量

您可以通过设置以下全局变量来定制 Hammer.vim 的行为：

• g:HAMMER_DIRECTORY：转换后的 HTML 文件保存路径，默认为 /tmp（UNIX）或 $TEMP（Windows）。
• g:HAMMER_BROWSER：用于查看 HTML 文件的浏览器路径，默认为 open（OSX）、start（Windows）或 xdg-open（X11）。
• g:HAMMER_TEMPLATE：使用的模板，默认为 default，即类似 GitHub README 的模板。
• g:HAMMER_BROWSER_ARGS：传递给浏览器的可选参数。在 OS X 上，设置为 -g 可以在后台打开浏览器窗口。

3. 项目 API 使用文档

3.1 命令

• :Hammer：将当前文件转换为 HTML 并在浏览器中打开。

3.2 自定义渲染器

Hammer.vim 支持多种标记语言，并且允许您添加自定义渲染器。您可以使用自己喜欢的模板语言（如 ERB、HAML 等）来设计布局。布局会接收渲染后的 HTML 作为部分内容。

4. 项目安装方式

4.1 手动安装

1. 克隆项目：

   $ git clone git://github.com/matthias-guenther/hammer.vim.git
   

2. 复制插件文件：

   $ cp -R hammer.vim/plugin/* $HOME/.vim/plugin
   

4.2 使用插件管理器

您也可以使用 Vim 插件管理器（如 Vundle、Pathogen 等）来安装 Hammer.vim。只需在插件管理器的配置文件中添加相应的插件路径即可。

通过以上步骤，您可以顺利安装并使用 Hammer.vim 插件，享受将标记语言转换为 HTML 并在浏览器中查看的便捷功能。