rtablada / markdown
使用静态方法调用的laravel风格markdown生成器
Requires
- php: >=5.3.8
This package is not auto-updated.
Last update: 2024-09-14 15:22:24 UTC
README
PHP的轻量级Laravel风格markdown创建器,用于composer。代码结构遵循http://daringfireball.net/projects/markdown/syntax中的语法
##安装
####使用Composer: { "require": { "Rtablada/Markdown": "0.1.*" }}
##使用
所有方法都是Rtablada\Markdown类上的静态调用。
利用composer自动加载器。
use \Rtablada\Markdown\Markdown;
###标题
简单的调用将返回h1元素:Markdown::heading('文本')
返回 # 文本
标题级别也可以作为第一个参数调用:Markdown::heading(2, '文本')
返回 ## 文本
如果传递给标题方法的有多行文本,只有第一行会被转换为标题,其余文本保持原样。Markdown::heading("文本\n新行")
返回 # 文本
###引用块
引用块支持多行,其中:Markdown::bockquote("文本\n新行")
返回 > 文本
###无序列表
无序列表可以使用字符串数组或多行字符串创建。它还接受一个可选的标记选项,允许用户指定星号或下划线(默认使用星号)。
Markdown::ul(['first', 'second'], '_')
和 Markdown::ul("first\nsecond]", '_')
都会生成:1. first
###有序列表
有序列表与无序列表类似。可选的第二个参数接受有序列表的起始点。
Markdown::ol(['first', 'second'])
和 Markdown::ol("first\nsecond]", '1')
都会生成:1. first
###代码块
代码块创建一个带标签的区域,它被转换为一个多行代码块
Markdown::codeblock("first\nsecond")
生成:\tfirst
###链接
链接可以创建为快捷链接
Markdown::link('http:://google.com')
: <http:://google.com>
或者完全功能的标记链接
Markdown::link('http:://google.com', '文本', '标题')
: [文本](http:://google.com
###强调
可以使用em方法创建强调
Markdown::em('文本')
: *文本*
也可以创建强强调块
Markdown::em('文本', '**')
: **文本**
Markdown::em('文本', '_')
: _文本_
###行内代码
可以创建行内代码
Markdown::code('{{ Form::open() }}', '**')
: `{{ Form::open() }}
###图片
图片元素将使用: Markdown::image('http://placehold.it/350x150', 'alt')
: 