mohsin-shaikh / ci-markdown

CI Markdown is a CodeIgniter library for parsing Markdown to HTML.

CI Markdown

CI Markdown is a modified rendition of Michel Fortin's PHP Markdown and PHP Markdown Extra for CodeIgniter.

Install

Requirements

• PHP version 5.2.4 or newer
• CodeIgniter version 2.x – v3.x

Download

Download and extract the zip release to your CoddeIgniter application/libraries/ directory.

The extracted path should resemble:

• application/libraries/Markdown.php

Using the Markdown Class

Configuration

Customized PHP Markdown settings can be specified in the config/markdown.php config file.

Initializing the Class

Like most other classes in CodeIgniter, the Markdown class is initialized in your controller using the $this->load->library() method:

$this->load->library('markdown');

Once loaded, the Markdown library object will be available using:

$this->markdown

Examples

Markdown Text to HTML

• $this->markdown->parse()

Accepts a single string parameter of Markdown text and returns the parsed HTML.

$this->load->library('markdown');

$markdownText = "# Heading "."\n\n"."## Sub-heading"."\n\n";
echo $this->markdown->parse($markdownText);
>>> <h1>Heading</h1><h2>Sub-heading</h2>

Markdown File to HTML

• $this->markdown->parse_file()

Accepts a single string parameter for a Markdown file path and returns the parsed HTML.

$this->load->library('markdown');

echo $this->markdown->parse_file('/path/to/markdown/file.md');
>>> <h1>CI Markdown</h1><p>CI Markdown is a modified rendition...</p>

Issues

For all issues including feature requests, please open a new issue.

Changes

See the Changelog page.

Credits

• John Gruber
• Michel Fortin

Author

• Jon LaBelle [e-mail]