redtape是使用github上有味降价来生成简单的,有吸引力的HTML文档的集中文档生成。它会自动集成了Twitter的引导和功能简单,有吸引力的造型。 redtape为d的启发,但尝试有一个简单的接口,同时仍然允许用户风格和控制其输出文件的定制化程度高。
安装
如果你是在Linux或OSX,可以使用画中画安装:
> PIP安装redtape
这将安装redtape和它的依赖。
用法
要在文件或目录完整的文档使用,运行室温。如果在目录中运行,室温将为每个降价文件HTML文件(.md,.mdown,或.markdown扩展):
> RT mydocument.md
> RT文档/
资产
默认情况下,室温假定您已经设置了服务于从具有室温链接到这些文件的资产文件的位置。布局是完全一样的redtape库中的资产目录:/资产/ {CSS,IMG,JS} / ..为您将使用每个资产。如果你想使用redtape默认的资产,你可以轻松地创建运行的当前目录合适的资产目录:
> RT --create资产
如果您正在运行在单一文件模式或不希望设立一个资产目录的最终主人为你的HTML文档,你可以告诉redtape嵌入使用--embed使用文档中的每个资产:
> RT --embed mydocument.md
JavaScript的
缺省情况下,redtape不需要任何JavaScript来运行,而不会嵌入任何在--embed模式。如果选择了--prettify选项,谷歌的美化库将用于源突出而不是pygments,并且如果--prettify和--embed都使用时,它将被自动地嵌入。
Redtape也适合简单的单页的javascript示范,并且如果--use-JS被启用,redtape将包括jQuery和引导的javascript库。
自定义输出
定制输出是很容易做到的各种方式。除了改变资产CSS非嵌入文档,你还可以添加页眉和页脚,甚至使用基于redtape的默认模板的自定义文档模板。
页眉和页脚
如果你有一个自定义文档页眉或页脚想要添加到您的文档,你可以添加了header.html和footer.html文件正在渲染的基本目录或设置默认路径在配置为页眉和页脚中使用。默认情况下,这些将被放置在文档的顶部和底部上。
文档的样本集可以是:
> LS mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs /了header.html mydocs / footer.html
渲染mydocs与RT mydocs将使用页眉和页脚目录中的每个文件。
自定义模板
如果你有非常具体的要求,你可以写你自己的文档模板,并具有输出的总量控制。 Redtape使用的Jinja2模板引擎,这是一种类似Django模板广泛使用的模板系统。运行redtape与--context说法得到一个简要的了解哪些变量可用的模板。
您也可以从basic.jinja,这是redtape的默认模板的名称继承。这个模板定义了两个街区,头部和身体,这样可以让你制作一个明显的文档身体,同时,例如,保留基本的CSS和redtape的JavaScript功能。覆盖两者都会给您留下一个标准的HTML5文档结构。
您可以指定一个自定义的模板-t使用,--template或将其放置在文档目录custom.html或custom.jinja
要求:
- 在Python中
评论没有发现