跳转到主要内容

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可以用单引号('')或双引号("")包围。

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 (10.0 kB 查看哈希值)

上传时间

由以下机构支持