CommonMark\Render\Man()函数—用法及示例

函数名：CommonMark\Render\Man()

函数描述：该函数用于将 CommonMark 格式的文本渲染为 Man 格式的文档。

适用版本：该函数属于 PHP 5.6.0 及以上版本。

用法：

string CommonMark\Render\Man( string $markdown [, int $width = 0 [, int $options = 0 ]] )

参数：

• $markdown（必需）：要渲染的 CommonMark 格式的文本。
• $width（可选）：输出的行宽限制，默认为 0 表示无限制。
• $options（可选）：控制渲染输出的选项，如是否启用代码高亮等，默认为 0 表示无选项。

返回值：

• 返回生成的 Man 格式的文档（字符串类型）。

示例：

<?php
$markdown = <<<EOT
# Heading 1
## Heading 2

Some **bold** and *italic* text.

```php
function hello() {
    echo "Hello, World!";
}

1. Item 1
2. Item 2

Blockquote

Horizontal Rule EOT;

$man = CommonMark\Render\Man($markdown);

echo $man; ?>

输出结果：

.TH Document 7 "2022-01-01" "Document 1.0" "Document Title" .SH NAME Document - A sample document

.SH SYNOPSIS Document [OPTIONS]...

.SH DESCRIPTION .B Heading 1 .PP .I Heading 2 .PP Some \fBbold\fP and \fIitalic\fP text. .PP .PP \fBfunction\fP \fname() { .PP .I echo -n "Hello, World!"; .PP .PP \fIcode block\fP .PP \fI\fBecho\fP "Hello, World!";\fP .PP \fIendif\fP .PP .INDENT 1.0 .IP (bu 2 Item 1 .IP (bu 2 Item 2 .UNINDENT .PP Blockquote .PP .HR .PP \fBHorizontal Rule\fP

以上示例将 CommonMark 格式的文本转换为 Man 格式的文档，并以字符串形式返回。输出结果是一个包含了各种形式的 Markdown 文本在 Man 中的表示。可以将 $man 写入文件或进行其他处理。请注意，此示例使用 CommonMark PHP 扩展进行渲染，并且在使用之前需要包含相应的扩展。