Fat-Free Framework: Markdown Class Reference

Fat-Free-Framework

Fat-Free Framework  3.1.0 API Reference

Markdown-to-HTML converter. More...

Inheritance diagram for Markdown:
Prefab

Public Member Functions

 esc ($str)
 
 scan ($str)
 
 convert ($txt)
 

Public Attributes

 $special
 Special characters.
 

Protected Member Functions

 _blockquote ($str)
 
 _pre ($str)
 
 _fence ($hint, $str)
 
 _hr ()
 
 _atx ($type, $str)
 
 _setext ($str, $type)
 
 _li ($str)
 
 _raw ($str)
 
 _p ($str)
 
 _text ($str)
 
 _img ($str)
 
 _a ($str)
 
 _auto ($str)
 
 _code ($str)
 
 snip ($str)
 
 build ($str)
 

Protected Attributes

 $blocks
 Parsing rules.
 

Additional Inherited Members

- Static Public Member Functions inherited from Prefab
static instance ()
 

Detailed Description

Markdown-to-HTML converter.

Member Function Documentation

Markdown::_a (   $str)
protected

Process anchor span

Returns
string
Parameters
$strstring
Markdown::_atx (   $type,
  $str 
)
protected

Process atx-style heading

Returns
string
Parameters
$typestring
$strstring
Markdown::_auto (   $str)
protected

Auto-convert links

Returns
string
Parameters
$strstring
Markdown::_blockquote (   $str)
protected

Process blockquote

Returns
string
Parameters
$strstring
Markdown::_code (   $str)
protected

Process code span

Returns
string
Parameters
$strstring
Markdown::_fence (   $hint,
  $str 
)
protected

Process fenced code block

Returns
string
Parameters
$hintstring
$strstring
Markdown::_hr ( )
protected

Process horizontal rule

Returns
string
Markdown::_img (   $str)
protected

Process image span

Returns
string
Parameters
$strstring
Markdown::_li (   $str)
protected

Process ordered/unordered list

Returns
string
Parameters
$strstring
Markdown::_p (   $str)
protected

Process paragraph

Returns
string
Parameters
$strstring
Markdown::_pre (   $str)
protected

Process whitespace-prefixed code block

Returns
string
Parameters
$strstring
Markdown::_raw (   $str)
protected

Ignore raw HTML

Returns
string
Parameters
$strstring
Markdown::_setext (   $str,
  $type 
)
protected

Process setext-style heading

Returns
string
Parameters
$strstring
$typestring
Markdown::_text (   $str)
protected

Process strong/em/strikethrough spans

Returns
string
Parameters
$strstring
Markdown::build (   $str)
protected

Assemble blocks

Returns
string
Parameters
$strstring
Markdown::convert (   $txt)

Render HTML equivalent of markdown

Returns
string
Parameters
$txtstring
Markdown::esc (   $str)

Convert characters to HTML entities

Returns
string
Parameters
$strstring
Markdown::scan (   $str)

Scan line for convertible spans

Returns
string
Parameters
$strstring
Markdown::snip (   $str)
protected

Reduce multiple line feeds

Returns
string
Parameters
$strstring

The documentation for this class was generated from the following file:
  • markdown.php
Generated on Mon Aug 19 2013 21:27:49 for Fat-Free Framework by   doxygen 1.8.4