index.md 1.8 KB


layout: default

title: Overview

CommonMark for PHP

Overview

Author Latest Version Total Downloads Software License Build Status Coverage Status Quality Score

{{ site.data.project.highlights.description }}

Installation

This library can be installed via Composer:

composer require league/commonmark

See the installation section for more details.

Basic Usage

Simply instantiate the converter and start converting some Markdown to HTML!

use League\CommonMark\CommonMarkConverter;

$converter = new CommonMarkConverter();
echo $converter->convertToHtml('# Hello World!');

// <h1>Hello World!</h1>

Important: See the basic usage and security sections for important details.