包简介

Markdown extension for ComfyPHP

README 文档

README

This is an extension for ComfyPHP framework to enable the function of using markdown as a page.

Before Using it

As this is an extension for ComfyPHP, All dependencies required in ComfyPHP and ComfyPHP itself is needed to use this extension.

Download / Install

To use this extension, you can install it with Composer.

composer require comfyphp/markdown

Initialize

Since this extension is based on Parsedown & Parsedown Extra, you may pass the configurations which accepted by it.

$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);

Then pass the variables into ComfyPHP\Core():

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

Create a routing to the target file:

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

Or use File-Based Routing if you like:

$core->fileBasedRouter();

Usage

After the initialization, you may create a markdown file in src/pages folder (default), let's take src/pages/markdown/index.md as the example:

Here we create a heading in the markdown file:

# This is My Markdown file {.heading}

This will create the HTML below after process:

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

For more information, you may take a look here.

Meta Tags / Elements

In addition to converting markdown content to HTML, you can also include the <head> sections at the beginning of the markdown file. ComfyPHP will read and convert them accordingly.

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

License

This project is MIT licensed, you can find the license file here.

comfyphp/markdown 适用场景与选型建议

comfyphp/markdown 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 9 次下载、GitHub Stars 达 0，最近一次更新时间为 2023 年 07 月 03 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「framework」「php」「markdown」「parse」「mark」「parsedown」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 comfyphp/markdown 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 comfyphp/markdown 我们能提供哪些服务？

定制开发 / 二次开发

基于 comfyphp/markdown 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 comfyphp/markdown 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

phphleb/hleb 292

PHP Framework HLEB2 is the foundation of the web application. Provides ease of development and application performance.

dg/texy 159

Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again

litalino/flarum-more-bbcode 2

Adds more BBCode

ins0/github-changelog-generator 14

Creates a markdown changelog for your GitHub repository.

varunsridharan/wp2github-md 0

Lightweight Application To Convert WordPress Readme Into Github Markdown

foxtes/alfabank-rest 1

Alfabank REST API integration