Download the PHP package neoground/charm-markdown without Composer
On this page you can find all versions of the php package neoground/charm-markdown. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download neoground/charm-markdown
More information about neoground/charm-markdown
Files in neoground/charm-markdown
Package charm-markdown
Short Description Charm Markdown Module
License MIT
Homepage https://neoground.com/projects/charm
Informations about the package charm-markdown
A Galactic Markdown Module for Charm Framework 3.1+
Welcome to the charm-markdown module, a remarkable addition to the Charm Framework galaxy, designed to provide seamless integration of Markdown and YAML frontmatter functions. Whether you're a Markdown padawan or a seasoned YAML-Frontmatter Jedi, this module is the perfect companion for your Charm framework journey.
Harness the power of Charm's built-in Symfony/Yaml package and Parsedown + Parsedown-Extra for HTML creation, bringing balance to the Markdown Force in your application.
Installation
Begin your quest by adding charm-markdown to your project via Composer:
Next, install charm-markdown in your application:
Usage
Awaken the charm-markdown Force by initializing it with a file or a string:
or
Unlock the secrets of the Markdown galaxy by accessing:
$doc->getMarkdownContent();
to obtain the Markdown content part of the document$doc->getYaml();
to retrieve the YAML frontmatter data as an array (or an empty array if not set)$doc->getHtml();
to generate the HTML content, with Markdown Extra support and "id" tags added to each heading for easy anchoring$doc->getContentsList()
to get an array of all headings as an easy table of contents
Experience the power of charm-markdown with direct access:
This returns an array with keys yaml
(array) and markdown
(string), containing each part of the document:
Extract the YAML array directly from the content string as an array:
Obtain the Markdown part directly from the content string as a string:
Format the Markdown part of the content string as HTML:
Usage in Views
In Twig views you can output a markdown string directly as HTML with:
Embrace the charm-markdown Force and embark on an epic adventure of Markdown and YAML mastery in your Charm Framework application. May the Markdown be with you!
All versions of charm-markdown with dependencies
neoground/charm Version ^3.1
erusev/parsedown Version ^1.7
erusev/parsedown-extra Version ^0.8.1