This is an extension for ComfyPHP framework to enable the function of using markdown as a page.
As this is an extension for ComfyPHP, All dependencies required in ComfyPHP and ComfyPHP itself is needed to use this extension.
To use this extension, you can install it with Composer.
composer require comfyphp/markdownSince 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();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.
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>This project is MIT licensed, you can find the license file here.