用于跟踪和构建文档的cli,特别是鹈鹕静态博客

kez的Python项目详细描述


一个简单的命令行实用程序,用于跟踪和生成文档, 特别是Pelican博客。

使用cliff作为用户界面, 与本地sqlite数据库对象一起映射 peewee

使用python-2.7和python-3.4进行测试。不太可能在窗户上工作。

用法

添加包含文档源文件的存储库:

$ kez add myblog git@github.com:averagehuman/maths.averagehuman.org.git

建立其中定义的任何文档:

$ kez build myblog

跟踪项目:

$ kez list
+---------+------------------------+---------+--------------------------------------------------------+
| Project | Document               | Type    | Url                                                    |
+---------+------------------------+---------+--------------------------------------------------------+
| myblog  | maths.averagehuman.org | PELICAN | git@github.com:averagehuman/maths.averagehuman.org.git |
+---------+------------------------+---------+--------------------------------------------------------+

生成后,如果有根index.html,请在 浏览器窗口:

$ kez serve myblog

配置

源存储库必须有一个名为 kez.cfg包含一个或多个节,其中每个节定义 一份特殊的文件。每个节中的\u docroot\u值 应该给出相对于配置文件的目录,其中 找到文档源(默认为配置文件的 目录)。

按照惯例,双下划线键是构建元选项,而 任何其他键都是程序所必需的或有意义的选项 被要求出示文件(如狮身人面像、鹈鹕等)。

示例kez.cfg

[maths.averagehuman.org]
__doctype__ = pelican
AUTHOR = Buzz Lightyear (MSc Phd)
SITENAME = Beyond Infinity
SITEURL = blog.beyondinfinity.net
ARTICLE_URL = {date:%Y}/{date:%m}/{slug}/
ARTICLE_LANG_URL = {date:%Y}/{date:%m}/{lang}/{slug}/
PAGE_URL = {slug}/
PAGE_LANG_URL = {lang}/{slug}/
ARTICLE_SAVE_AS = {date:%Y}/{date:%m}/{slug}/index.html
ARTICLE_LANG_SAVE_AS = {lang}/{date:%Y}/{date:%m}/{slug}/index.html
PAGE_SAVE_AS = {slug}/index.html
PAGE_LANG_SAVE_AS = {lang}/{slug}/index.html

支持的文档类型

  • 鹈鹕

在未来,可能是sphinx

测试

使用python 2python 3运行测试:

$ make test
$ make test PYVERSION=2
$ make test PYVERSION=3

python 3是默认值(如果未指定pyversion)。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java无法启动应用程序:JNLP错误   java根据用户输入在PreparedStatement中使用setTime()或setNull()   java EJB与同步   java以object为键通过hashmap进行搜索   java中的模10^9+7   针对包含其他对象的对象的java OOP最佳实践   如何将字符串作为HTML代码从Java文件读取到JSP页面?   java我的POM怎么了?“解析表达式..检测到递归表达式循环”   用于Hbase的Mapreduce的java NoSuchMethodError   JAVAlang.SecurityException:权限拒绝:启动意图{act=安卓.Intent.action.MAIN cat=[安卓.Intent.category.LAUNCHER]   数组初始化谜语Java   通过arraylist搜索时的java句柄关联