kramdown - 云端在线

程序：

您的姓名

kramdown - 一个快速的纯 Ruby Markdown 超集转换器

概要

镇压 [选项[文件 ...]

商品描述

kramdown 主要用于解析 Markdown 的超集并将其转换为
不同的输出格式。 它支持标准 Markdown（有一些小的修改）
以及各种扩展，如表格和定义列表。 由于其模块化架构
它还允许除 Markdown 之外的其他输入格式，例如 HTML 或 Github Flavored
降价。

If 文件 未指定，kramdown 从标准输入读取。 结果写入
标准输出。

kramdown 接受两组选项：第一组包括选项
由 kramdown 二进制文件直接使用。 第二组选项控制如何
kramdown 解析并转换其输入。

配置

-一世， - 输入 ARG
指定输入格式。 可用的输入格式：kramdown（这是默认值），
降价、GFM 或 html。

-o， - 输出 ARG
指定一种或多种以逗号分隔的输出格式：html（默认）、kramdown、
乳胶、pdf 或 remove_html_tags。

-v， - 版
显示 kramdown 的版本。

-H， - 帮帮我
显示帮助。

镇压 配置

--auto-id-前缀 ARG

用于自动生成的标题 ID 的前缀

此选项可用于为自动生成的标头 ID 设置前缀
以便在将多个 kramdown 文档渲染为一个时不会发生冲突
分别输出文件。 前缀应该只包含在
身份证！

默认值：'' 使用者：HTML/Latex 转换器

--[no-]自动 id 剥离

从标题文本中去除所有格式以自动生成 ID

如果此选项为“true”，则仅标题的文本元素用于
稍后生成 ID（与仅使用原始标题文本行相比）。

此选项将在 2.0 版中删除，因为这将是默认设置。

默认值：false 使用者：kramdown 解析器

--[no-] 自动 ID

使用自动标题 ID 生成

如果此选项为“true”，则在以下情况下会自动生成所有标题的 ID 值
没有明确指定 ID。

默认值：true 使用者：HTML/Latex 转换器

--coderay-粗体-每个 ARG

定义行号加粗的频率

可以是整数或假（完全关闭粗体行号）。

默认值：10 使用者：HTML 转换器

--coderay-css ARG

定义突出显示的代码如何设置样式

可能的值是 :class （CSS 类应用于代码元素，必须
提供所需的 CSS 文件）或 :style（默认 CSS 样式直接应用于
代码元素）。

默认值：style 使用者：HTML 转换器

--coderay-默认语言 ARG

设置用于突出显示代码块的默认语言

如果没有为代码块设置语言，则使用默认语言。 这
value 必须是 coderay 支持的语言之一，如果没有默认值则为零
应该使用语言。

默认值：nil 使用者：HTML 转换器

--coderay-行号-开始 ARG

行号的起始值

默认值：1 使用者：HTML 转换器

--coderay-行号 ARG

定义如何以及是否应该显示行号

可能的值是 :table、:inline 或 nil。 如果此选项为零，则无行
显示数字。

默认值： :inline 使用者： HTML 转换器

--coderay-制表符宽度 ARG

突出显示代码中使用的标签宽度

使用者：HTML 转换器

--coderay-wrap ARG

定义应如何包装突出显示的代码

可能的值为:span、:div 或 nil。

默认值：:div 使用者：HTML 转换器

--[no-] 启用-coderay

使用 coderay 进行语法高亮

如果此选项为“true”，则 HTML 转换器使用 coderay 进行语法
突出显示代码跨度和代码块的内容。

默认值：true 使用者：HTML 转换器

--实体输出 ARG

定义实体的输出方式

可能的值为 :as_input （实体以与
输入), :numeric (实体以数字形式输出), :symbolic (实体是
如果可能，以符号形式输出）或 :as_char（实体作为字符输出
如果可能，仅在 Ruby 1.9 上可用）。

默认值：:as_char 使用者：HTML 转换器、kramdown 转换器

--footnote-反向链接 ARG

定义应用于脚注反向链接的文本

脚注反向链接只是文本，因此任何特殊的 HTML 字符都将被转义。

如果脚注 backlint 文本是空字符串，则不会出现脚注反向链接
产生。

默认值：'&8617;' 使用者：HTML 转换器

--脚注编号 ARG

第一个脚注的编号

此选项可用于指定用于第一个脚注的编号。

默认值：1 使用者：HTML 转换器

--[no-] 硬包装

从字面上解释换行符

插入 HTML ` ` 在原始 Markdown 文档的段落内标记
有换行符（默认情况下，Markdown 忽略这些换行符）。

默认值：true 使用者：GFM 解析器

--标头偏移量 ARG

设置标题的输出偏移量

如果此选项为 c（也可能为负），则级别为 n 的标题将是
输出为级别为 c+n 的标题。 如果 c+n 小于 1，将使用级别 1。 如果
c+n 大于 6，将使用级别 6。

默认值：0 使用者：HTML 转换器、Kramdown 转换器、Latex 转换器

--[no-]html-to-native

将 HTML 元素转换为原生元素

如果此选项为“true”，解析器会将 HTML 元素转换为原生元素。 为了
例如，当解析 ` hallo` 时，强调标签通常会被转换
到标签类型为 `:em` 的 `:html` 元素。 如果 `html_to_native` 为 `true`，则
重点将转换为原生`:em` 元素。

这对于无法处理 HTML 元素的转换器很有用。

默认值：false 使用者：kramdown 解析器

--乳胶标题 ARG

为不同的标题级别定义 LaTeX 命令

可以通过将它们分开来指定用于标题级别 XNUMX 到 XNUMX 的命令
用逗号。

默认：section,subsection,subsubsection,paragraph,subparagraph,subparagraph 使用
作者：乳胶转换器

- 行宽 ARG

定义输出文档时要使用的线宽

默认值：72 使用者：kramdown 转换器

--链接定义 ARG

预定义链接定义

此选项可用于预定义链接定义。 该值必须是
哈希，其中键是链接标识符，值是两个元素数组
带有链接 URL 和链接标题。

如果值是一个字符串，它必须包含一个有效的 YAML 散列，并且散列必须
遵循上述准则。

默认值：{} 使用者：kramdown 解析器

--数学引擎 ARG

设置数学引擎

指定用于转换数学块/跨度的数学引擎。 如果
此选项设置为 +nil+，不使用数学引擎，数学块/跨度为
按原样输出。

可以使用 math_engine_opts 设置所选数学引擎的选项
配置选项。

默认值：mathjax 使用者：HTML 转换器

--数学引擎选项 ARG

设置数学引擎选项

通过 math_engine 配置选项指定数学引擎设置的选项。

该值需要是一个散列，其中包含被使用的键值对
数学引擎。

默认值：{} 使用者：HTML 转换器

--[无-]解析块-html

在块 HTML 标签中处理 kramdown 语法

如果此选项为“true”，则 kramdown 解析器处理块 HTML 的内容
标签作为包含块级元素的文本。 由于这通常不想要，
默认值为`false`。 通常最好有选择地启用 kramdown
通过 markdown 属性处理。

默认值：false 使用者：kramdown 解析器

--[无-]解析-span-html

在 span HTML 标签中处理 kramdown 语法

如果此选项为“true”，则 kramdown 解析器处理 span HTML 的内容
标签作为包含跨度级元素的文本。

默认值：true 使用者：kramdown 解析器

--[no-]删除块 html 标签

删除块 HTML 标签

如果此选项为“true”，RemoveHtmlTags 转换器将删除块 HTML 标记。

默认值：true 使用者：RemoveHtmlTags 转换器

--[no-]删除-span-html-标签

移除 span HTML 标签

如果此选项为“true”，RemoveHtmlTags 转换器将删除跨度 HTML 标签。

默认值：false 使用者：RemoveHtmlTags 转换器

--智能引号 ARG

为智能报价输出定义 HTML 实体名称或代码点

由实体名称或代码点标识的实体应该用于，在
顺序，左单引号，右单引号，左双和右双
引号是通过用逗号分隔它们来指定的。

默认值：lsquo,rsquo,ldquo,rdquo 使用者：HTML/Latex 转换器

--语法高亮 ARG

设置语法高亮

指定用于高亮代码块的语法高亮器
和跨度。 如果此选项设置为 +nil+，则不进行语法高亮显示。

可以使用 syntax_highlighter_opts 设置语法高亮选项
配置选项。

默认值：coderay 使用者：HTML/Latex 转换器

--语法荧光笔选项 ARG

设置语法高亮选项

指定通过 syntax_highlighter 设置的语法高亮选项
配置选项。

该值需要是一个散列，其中包含被使用的键值对
语法高亮。

默认值：{} 使用者：HTML/Latex 转换器

- 模板 ARG

用于包装输出或 ERB 的 ERB 模板文件的名称
模板本身。

这用于将输出包装在环境中，以便输出可以用作
一个独立的文件。 例如，一个 HTML 模板将提供所需的
header 和 body 标签，以便整个输出是一个有效的 HTML 文件。 如果没有模板
指定，输出将只是转换后的文本。

解析模板文件时，首先使用给定的模板名称。 如果这样一个
找不到文件，转换器扩展名（与转换器名称相同）是
附加。 如果仍然找不到文件，模板名称将被解释为
kramdown 提供的模板名称（不带转换器扩展）。 如果
仍然找不到文件，检查模板名称是否以
'string://' 如果是，则删除此前缀，其余部分用作模板
内容。

kramdown 为每个转换器提供一个名为“document”的默认模板。

默认值：'' 使用者：所有转换器

--toc 级别 ARG

定义用于目录的级别

可以通过用逗号分隔来指定各个级别（例如 1,2,3）
或使用范围语法（例如 1..3）。 仅指定级别用于
目录。

默认值：1..6 使用者：HTML/Latex 转换器

--[no-]音译标头id

在生成 ID 之前音译标题文本

标头 ID 中仅使用 ASCII 字符。 这对具有以下特征的语言不利
许多非 ASCII 字符。 通过启用此选项，标题文本是
尽可能好地音译为 ASCII，以便生成的标题 ID 更
有用。

需要安装 stringex 库才能使用此功能！

默认值：false 使用者：HTML/Latex 转换器

退出 状态

如果没有发生错误，退出状态为 0。 否则为 1。

使用 onworks.net 服务在线使用 kramdown