简单小巧的文档生成器
项目描述
redtape
redtape 是一个专注于文档生成器，它使用 github flavored markdown 来生成简单、吸引人的HTML文档。它自动与 twitter bootstrap 集成，并具有简单、吸引人的样式。它受 d 的启发，但试图在保持简单界面的同时，仍然允许用户以高度定制化的方式来样式化和控制他们的输出文档。
安装
如果您使用的是linux或OSX，可以使用 pip 来安装
> pip install redtape
这将安装redtape及其依赖项。
用法
要使用，请在文档或包含大量文档的目录上运行 rt。如果在一个目录上运行，rt 将为每个markdown文件（.md、.mdown 或 .markdown 扩展名）创建HTML文件
> rt mydocument.md > rt documentation/
资源
默认情况下，rt 假设您已经设置了一个位置来提供包含 rt 在文档中链接到的资源的文件。布局与 redtape 仓库中的 资源目录 完全相同：为每个您将使用的资源 /assets/{css,img,js}/..。如果您想使用 redtape 的默认资源，您可以通过运行以下命令在当前目录中轻松创建一个合适的资源目录：
> rt --create-assets
如果您正在单文档模式下运行或不想在最终的 HTML 文档宿主上设置资源目录，您可以通过使用 --embed 来告诉 redtape 在文档中嵌入每个使用的资源。
> rt --embed mydocument.md
javascript
默认情况下，redtape 不需要任何javascript来运行，并且在 --embed 模式下也不会嵌入任何javascript。如果选择了 --prettify 选项，则将使用 google 的 prettify 库进行源代码高亮，而不是 pygments，如果同时使用了 --prettify 和 --embed，它将自动嵌入。
Redtape 也适用于简单的单页javascript演示，如果启用了 --use-js，redtape 将包含 jquery 和 bootstrap 的javascript库。
自定义输出
通过多种方式都可以轻松自定义输出。除了更改非嵌入文档的资产CSS外，您还可以添加页眉和页脚，甚至可以使用基于 redtape 默认模板的自定义文档模板。
自定义模板
如果您有非常具体的要求，您可以编写自己的文档模板并完全控制输出。Redtape 使用 jinja2 模板引擎，这是一个广泛使用的与 django 模板类似的模板系统。运行 redtape 并带有 --context 参数以获得有关模板可用的变量的简要说明。
您也可以从 basic.jinja 继承，这是 redtape 默认模板的名称。此模板定义了两个块，head 和 body，这将允许您创建独特的文档主体，同时保留 redtape 的基本 CSS 和 JavaScript 功能。覆盖两者将使您获得标准的 HTML5 文档结构。
您可以使用 -t, --template 指定要使用的自定义模板，或将其放置在文档目录中作为 custom.html 或 custom.jinja。
示例输出
redtape-1.2.tar.gz 的散列值
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | b3ce01cd001ac6e7db76f565e4b41f58bc7c729a063a36451b406bfbb156ff2b |
|
| MD5 | b524bcd195bba8b159102cc032246810 |
|
| BLAKE2b-256 | cba9553e2ff0b4f0085e11ee6e1930a939180b2a676e629de58aee69a26449f6 |