jonlabelle/ci-markdown


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

  • Users starred: 83
  • Users forked: 34
  • Users watching: 83
  • Updated at: 2020-06-19 04:24:10

CI Markdown

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

Install

Requirements

Download

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

The extracted path should resemble:

  • application/libraries/Markdown.php

Usage

Configuration

Custom PHP Markdown settings are defined in the config/markdown.php config file.

Initializing the Markdown Class

Like most other classes in CodeIgniter, initialize it from your controller using the $this->load->library() method:

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

To programmatically configure the Markdown instance, overriding any matched settings defined in the config file:

$config = array(
    'tab_width' => 2,
    'no_markup' => true,
    'empty_element_suffix' => '/>'
);

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

Markdown 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

Author