README

这是一个 ComfyPHP 框架的扩展，用于启用将 Markdown 作为页面功能。

使用之前

由于这是一个 ComfyPHP 的扩展，因此需要使用此扩展时，需要所有 ComfyPHP 所需的依赖项以及 ComfyPHP 本身。

下载 / 安装

要使用此扩展，您可以使用 Composer 进行安装。

composer require comfyphp/markdown

初始化

由于此扩展基于 Parsedown 及 Parsedown Extra，您可以传递它接受的配置。

$config = [
    "setBreaksEnabled" => true,
    "setMarkupEscaped" => true,
    "setUrlsLinked" => false,
    "setSafeMode" => true,
];

// This extension will modify the router and document of ComfyPHP
$router = new ComfyPHP\Markdown\Router();
$document = new ComfyPHP\Markdown\Document($config);

然后传递变量到 ComfyPHP\Core()

$core = new ComfyPHP\Core([
    "router" => $router,
    "document" => $document,
]);

创建指向目标文件的路由

$core->getRouter()->get("/md", "/markdown/index");

或者如果您喜欢，可以使用基于文件的路由

$core->fileBasedRouter();

用法

初始化后，您可以在 src/pages 文件夹（默认）中创建一个 markdown 文件，例如 src/pages/markdown/index.md

在这里我们创建 markdown 文件中的标题

# This is My Markdown file {.heading}

这将处理后的 HTML 生成以下内容

<h1 class="heading">This is My Markdown file</h1>

有关更多信息，请参阅此处。

元标签 / 元素

除了将 markdown 内容转换为 HTML，您还可以在 markdown 文件的开始处包含 <head> 部分。ComfyPHP 将读取并相应地转换它们。

<head>
    <title>Title</title>
</head>

许可

此项目采用 MIT 许可，您可以在此处找到许可文件。

comfyphp / markdown

维护者

详细信息

README

使用之前

下载 / 安装

初始化

用法

元标签 / 元素

许可