简介

在ST2和ST3中测试过

此包旨在帮助在Sublime中构建法律文件。目前该包有两个组件。第一个是一组用于Sublime中语法高亮的语言文件lmd文件。第二个是一组使用lmd语法构建和导出文档的功能。这组功能将

• 自动化构建lmd YAML 前置信息
• 将lmd文件转换为常规md文件
• 将lmd文件转换为Pandoc支持的任何格式。

该包有意见，因为我更喜欢使用Pandoc，以及我的Legal Markdown Gem来格式化使用pandoc全部功能的文档。该包使用Gem作为预处理工具，并使用Pandoc作为主要工具。为了使那些可能不想安装Gem的用户更容易使用，已将ruby文件提取到包中作为独立的ruby文件，因此如果仅仅包括该包则不需要安装Gem。确实，包将依赖于包含的ruby文件，即使您的系统上已安装，也不会调用该Gem。

如果不想使用Pandoc，您仍然可以在系统有Ruby的情况下，没有任何问题地使用该包的其他功能。

依赖项

您需要在本包中安装并设置ruby和pandoc并将其路径添加到环境变量，以便完全工作。如果您有非标准的ruby或pandoc安装，例如如果从cabal安装了pandoc，则在命令行中输入which pandoc，并将输出（不包含pandoc部分）复制到Legal Markdown包的用户设置中的pandoc-path（首选项-＞包设置-＞Legal Markdown-＞设置 - 用户）。

对于Ruby来说，情况类似，但如果你使用过rvm或者已经安装了ruby环境，应该可以正常工作。如果直接不行，那么在命令行中输入which ruby（或在Windows中where ruby），将返回ruby可执行文件。将命令输出粘贴到用户设置文件中。如果你正在使用Windows版本的Sublime，需要转义反斜杠，设置文件将类似于以下这样

"ruby-path": "C:\\Path\\To\\Ruby\\bin\\ruby.exe",

使用

第1步 - 构建YAML前部

该插件帮助你使用可选条款、混入和按格式构建法律文档模板，这些格式在legal_markdown gem中确定。

我在很长模板中找到了这个功能非常有用，尤其是当我修改了文件深处的某些条款时。要构建YAML前部，只需打开命令面板，找到“Legal Markdown - Make YAML Front Matter”。就这样。我当前有一个默认的快捷键ctrl+shift+l，然后是ctrl+shift+y，这也可以运行该命令。

第2a步 - 解析Legal Markdown创建普通Markdown

在你完成模板后，无论是分支还是其他操作，都可以轻松地将Legal Markdown解析为普通Markdown。要使用此功能，请打开命令面板，找到“Legal Markdown - Convert to Normal Markdown”。你也可以使用默认快捷键ctrl+shift+l然后是ctrl+shift+m来运行命令（或者你可以在用户目录中设置的其他任何快捷键）。我非常喜欢将它与非常棒的Markdown Preview Package结合使用，以在我的浏览器中查看lmd文件。当你想阅读法律等文件时，这非常好。

第2b步 - 使用Pandoc解析Legal Markdown创建DOCX、ODT、PDF等文件

这个包集成了Pandoc。我集成的Pandoc与我之前为Sublime文本集成的其他Pandoc集成的方式略有不同。其他集成在其用途上非常胜任，但我想要构建一个更为紧密集成的产品。

这个包的Pandoc集成哲学是将文档类型（客户备忘录、内部研究备忘录、交易合同、公司治理等）定义为设置中，当你要导出一个lmd文件时，只需选择该文档类型即可。所以你可以这样做。

转到“首选项” -> “包设置” -> “Legal Markdown” -> “设置” -> “默认”。复制build-format块的格式。然后转到“首选项” -> “包设置” -> “Legal Markdown” -> “设置” -> “用户”，将块粘贴到设置文件中。然后你可以根据需要创建文档类型。以下是一个说明（如果你更喜欢，你也可以直接将以下内容粘贴到你的用户设置文件中。）：

"build-formats": {
    "Memo": {                                                   // Name of the Document Type
      "from": ["markdown+fancy_lists+startnum"],                // The pandoc reader options ... note this is pandoc 1.10+ format so be careful using +/-
      "to": ["odt", "--reference-odt", "~/.pandoc/memo.odt"],   // The pandoc writer options
      "options": ["-S", "--normalize"],                         // The pandoc general options
      "file-output": "true",                                    // Use if you want to output to a file, or use the pandoc -o flag
      "open-file-after-build": "libreoffice"                    // Command to open the document with. Delete field if you don't want to automatically open the file.
    }
}

安装

使用Git安装

你可以通过直接在Sublime Text 2应用设置区域中的包目录中克隆repo来安装主题并保持更新。你可以通过使用“首选项” -> “浏览包”菜单项来定位你的Sublime Text 2包目录。在文件夹内部，使用以下命令克隆主题仓库：

$ git clone https://github.com/compleatang/Legal-Markdown-Sublime.git

手动安装

要手动下载和安装包

• 使用GitHub .zip下载选项下载文件
• 解压文件，并将文件夹重命名为“粘贴PDF”
• 将文件夹移动到你的Sublime Text 2包目录中

贡献

请随意添加您自己的代码片段。这将有助于使用Sublime的律师社区。要贡献，请按照以下步骤操作。

1. 从你的Sublime包文件夹，你将想要通过键入以下命令克隆仓库：git clone [email protected]:compleatang/Legal-Markdown-Sublime.git。
2. 在GitHub中，你将想要将该仓库分叉到你自己的账户。请通过在仓库右上角的“Fork”按钮上按一下来完成这个操作。
3. 下一类型（来自您的仓库所在的文件夹） git remote add myfork [email protected]:[您的用户名]/Legal-Markdown-Sublime.git。
4. 然后您就可以添加任何您想要的代码片段。

您添加新文件后，只需将代码提交，推送至您的GitHub分叉，然后发送一个pull请求。

源代码

MIT许可 - © 2013 - 水坝法律服务公司，PLLC

待办事项/路线图

• [X] 集成自动构建YAML前置文档的功能。
• [X] 集成Gem功能将法律Markdown渲染为完整Markdown。
• [X] 为lmd语言提供语法高亮。
• [X] 集成Pandoc。
• [ ] 为...?ASK?...和...?CONFIRM?...提供快捷键。
• [ ] 从模板中的问题制作清单。