argot文本标记 -- markdown方言
项目描述
Argot 是对 markdown 标记语言的一组小扩展,主要用于编写技术博客文章。这些扩展不是“正确”的markdown扩展;它们作为预处理器实现,编译成markdown或html语法。除了markdown的常规语法外(Argot不会干扰这些语法),Argot还提供了以下功能:
您可以使用pip安装Argot
pip install argot
您可以从其hg仓库 fork Argot
hg clone http://bitbucket.org/jmoiron/argot/
要求
argot 需要 markdown 和 pygments。默认禁用的可选的亚马逊链接处理器需要 lxml。
版本 0.6 注记
Argot 的 0.6 版本向 argot 脚本添加了一些功能,允许您通过一个简单的命令轻松地将 argot 标记转换为完整的 HTML 文档(带有 pygments 风格)。
Argot 0.6 版本与 0.5 版本 向后兼容,但保留了引用块,使其与 0.5 版本之前的版本不兼容。如果您使用的是小于 0.5 的版本并且希望升级,请参阅 0.5 版本的 README.rst 文件,以获取完整的不兼容性列表。
moin-style高亮代码块
在Markdown中,代码块是从正文文本缩进一级的文本块。然而,当处理更原始的浏览器输入机制时,过多的缩进可能会引起问题(因为制表符经常改变输入焦点)。除了允许这种约定外,argot还实现了moin/tracwiki风格的代码块,该代码块通过pygments实现语法高亮。
语法
一般的语法是‘{{{’,后面跟着可选的shebang和所需的pygments解析器,然后是您的代码块,最后以‘}}}’结束。
{{{#!parser ... code ... }}}
默认情况下,如果没有提供解析器,argot将使用pygments尝试猜测所使用的语言。如果使用纯文本解析器,它会回退到纯文本解析器。如果您想强制使用文本解析器,请使用text解析器。
引用块
与moin风格的代码块类似,引用块主要用于将引用的块轻松地剪切/粘贴到正文。
语法
引用块的语法与代码块类似,只是使用括号而不是花括号。
((("citation url" quoted text )))
引用文本将通过常规Markdown语法规则转换为HTML。不支持嵌套引用块。可选的引用URL可以用单引号('')或双引号("")包围。
链接目标处理器
Markdown链接的格式为[链接 文本](url),但这往往会打断写作,需要寻找可能复杂或未知的URL。与链接到URL不同,argot允许您以自定义方式编码目标信息。
语法
链接处理器由处理器标签、冒号和针对该处理器的查询组成。例如:
[Quick reStructured Text](google: restructured text quick ref)
这调用链接处理器google,查询为restructured text quick ref。默认情况下,只有链接处理器google被启用。有一个可启用的amazon链接处理器,但建议对于稳定的查询,在google查询后附加“amazon”。
设置Google引用
Google的Ajax搜索API(链接处理器使用)要求您设置引用URL。如果您设置了Google引用,Argot将获取第一个链接并直接使用该URL。
from argot import set_google_referer set_google_referer('http://example.com')
默认情况下,Google链接处理器将返回指向“我很幸运”的Google搜索页面的URL,然后转发到第一个搜索结果。强烈建议您缓存argot渲染的结果,因为每次页面加载时都搜索Google会非常慢。
编写新的链接处理器
链接处理器是函数,它接受单个参数,即作为字符串的查询,并返回另一个字符串。
def wiki_processor(query): return google_processor('wikipedia %s' % query) argot.enable_link_processor(wiki_processor)
这个假设的wiki处理器仅对“wikipedia”和提供的查询进行Google搜索。处理器标签可以通过以下三种方式提供:
第一个下划线之前函数的名称
函数上的tag属性
可选的enable_link_processor的第二个参数
argot命令行工具
与markdown一样,argot附带一个命令行工具,该工具将文本文件转换为HTML,称为argot。其用法是:
Usage: argot [options] file Options: --version show program's version number and exit -h, --help show this help message and exit -r REFERER, --referer=REFERER http referer for google link parser -d, --document render as full html document -t TITLE, --title=TITLE title to use in HEAD (implies -d) -s STYLE, --style=STYLE pygments style to use
使用-d选项,argot将创建一个带有指定pygments样式的完整HTML文档(默认为default)。
项目详情
Argot-0.6.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 6274944c132c30ae80c1b41cbd161859ba1c211623a6de08ea7ad5fed941af06 |
|
MD5 | 797c5a37ef01537dc855adad6c37dc79 |
|
BLAKE2b-256 | c658a6a6408f530d3d22e002616558a47280e84c30a00e30ca06d15c15ddc652 |