<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Introduction</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="book.cmark.html">CommonMark</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cmark.setup.html">Installing/Configuring</a></div>
<div class="up"><a href="book.cmark.html">CommonMark</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intro.cmark" class="preface">
<h1 class="title">Introduction</h1>
<p class="para">
This extension provides access to the reference implementation of CommonMark, a rationalized version of Markdown syntax with a specification.
</p>
<p class="formalpara">
<h5 class="title">Parsing:</h5>
<p class="para">
The CommonMark extension provides a simple parsing API:
<div class="methodsynopsis dc-description">
<span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <span class="methodname"><a href="function.commonmark-parse.html" class="methodname">CommonMark\Parse</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$content</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
</p>
</p>
<p class="formalpara">
<h5 class="title">Rendering:</h5>
<p class="para">
The CommonMark extension provides simple rendering API that supports multiple formats:
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.commonmark-render.html" class="methodname">CommonMark\Render</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <code class="parameter">$node</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.commonmark-render-html.html" class="methodname">CommonMark\Render\HTML</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <code class="parameter">$node</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.commonmark-render-xml.html" class="methodname">CommonMark\Render\XML</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <code class="parameter">$node</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.commonmark-render-man.html" class="methodname">CommonMark\Render\Man</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <code class="parameter">$node</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.commonmark-render-latex.html" class="methodname">CommonMark\Render\Latex</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Node">CommonMark\Node</span></span> <code class="parameter">$node</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$width</code></span>
]] )</div>
</p>
</p>
<p class="formalpara">
<h5 class="title">AST:</h5>
<p class="para">
The CommonMark extension implements visitation for CommonMark\Node objects:
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><a href="commonmark-node.accept.html" class="methodname">CommonMark\Node::accept</a></span>
( <span class="methodparam"><span class="type"><span class="type CommonMark\Interfaces\IVisitor">CommonMark\Interfaces\IVisitor</span></span> <code class="parameter">$visitor</code></span>
)</div>
</p>
</p>
<p class="formalpara">
<h5 class="title">CQL:</h5>
<p class="para">
The CommonMark extension provides an interface to CQL, CommonMark Query Language:
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="commonmark-cql.construct.html" class="methodname">CommonMark\CQL::__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
</p>
</p>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="book.cmark.html">CommonMark</a></div>
<div class="next" style="text-align: right; float: right;"><a href="cmark.setup.html">Installing/Configuring</a></div>
<div class="up"><a href="book.cmark.html">CommonMark</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
