aardio 文档

string.markdown 库模块帮助文档

string 成员列表

string.markdown()

返回对象:stringMarkdownObject

string.markdown(extensions,maxNesting,htmlOpt)

创建 MARKDOWN 解析器,所有参数可选

string.markdown(extensions,maxNesting,htmlOpt,自定义回调函数)

string.markdown(8,,,{  
    blockcode = function(ob, text, lang, opaque){    
        ob = string.markdown.buffer(ob);  
        text = string.markdown.buffer(text);  
        ob.put( tostring(text) )  
    };   
} );

string.markdown 成员列表

string.markdown.buffer()

返回对象:stringMarkdownBufObject

string.markdown.buffer(缓冲区初始大小)

创建缓冲区,参数可选

stringMarkdownBufObject 成员列表

stringMarkdownBufObject.data()

返回缓冲区指针

stringMarkdownBufObject.grow(增加大小)

增加缓冲区大小

stringMarkdownBufObject.printf("%s",其他格式化参数)

写放格式化字符串,
格式化语法与 string.format相同

stringMarkdownBufObject.put(写入数据,长度)

写入数据到缓冲区,长度为可选参数

stringMarkdownBufObject.size()

返回缓冲区数据大小

stringMarkdownBufObject.totring()

返回缓冲区文本

stringMarkdownObject 成员列表

stringMarkdownObject.free()

释放解析器对象,
该函数可在对象回收时自动调用

stringMarkdownObject.render(markdownText)

解析参数 @markdownText 指定的 Markdown 文本并返回 HTML。
自动调用 tostring 函数将参数 @markdownText 转换为字符串。

stringMarkdownObject.renderFile(markdownFilePath)

解析参数 @markdownFilePath 指定的 Markdown 文件并返回 HTML

自动完成常量

_MD_HTML_ESCAPE=0x200
_MD_HTML_EXPAND_TABS=0x10
_MD_HTML_HARD_WRAP=0x80
_MD_HTML_SAFELINK=0x20
_MD_HTML_SKIP_HTML=1
_MD_HTML_SKIP_IMAGES=4
_MD_HTML_SKIP_LINKS=8
_MD_HTML_SKIP_STYLE=2
_MD_HTML_TAG_CLOSE=2
_MD_HTML_TAG_NONE=0
_MD_HTML_TAG_OPEN=1
_MD_HTML_TOC=0x40
_MD_HTML_USE_XHTML=0x100
_MD_MKDA_EMAIL=2
_MD_MKDA_NORMAL=1
_MD_MKDA_NOT_AUTOLINK=0
_MD_MKDEXT_AUTOLINK=8
_MD_MKDEXT_FENCED_CODE=4
_MD_MKDEXT_LAX_SPACING=0x100
_MD_MKDEXT_NO_INTRA_EMPHASIS=1
_MD_MKDEXT_SPACE_HEADERS=0x40
_MD_MKDEXT_STRIKETHROUGH=0x10
_MD_MKDEXT_SUPERSCRIPT=0x80
_MD_MKDEXT_TABLES=2
_MD_MKD_TABLE_ALIGNMASK=3
_MD_MKD_TABLE_ALIGN_CENTER=3
_MD_MKD_TABLE_ALIGN_L=1
_MD_MKD_TABLE_ALIGN_R=2
_MD_MKD_TABLE_HEADER=4

Markdown 格式