README

这是一个用于解析 markdown 文件或字符串的 Laravel 5 包。支持 传统 Markdown 和 Github Flavored Markdown 语法。

内容表

• 待办事项
• 功能
• 安装
• 配置
• 用法

回到顶部

待办事项

• 修复传入的 bug
• 完成文档

回到顶部

功能

• 支持 传统 和 GFM markdown 语法
• 易于添加新规则和皮肤

回到顶部

安装

通过 composer 在项目根目录下运行以下命令

composer require vi-kon/laravel-markdown-parser

在您的 Laravel 5 项目中，将以下行添加到 app.php

// to your providers array
'ViKon\ParserMarkdown\ParserMarkdownServiceProvider',

回到顶部

用法

首先需要创建类并设置 markdown 规则

$parser = new Parser();
$lexer = new Lexer();
$renderer = new Renderer();

// Initialize parser with markdown rules
$ruleSet = new MarkdownRuleSet();
$ruleSet->init($parser, $lexer);

然后需要设置渲染器。有多种皮肤，包括 bootstrap 和 markdown。

// Set bootstrap renderer
$bootstrapSkin = new BootstrapSkin();
$bootstrapSkin->init($parser, $renderer);

// Set markdown renderer
$markdownSkin = new MarkdownSkin();
$markdownSkin->init($parser, $renderer);

bootstrap 皮肤使用 Bootstrap 标签和样式输出 HTML 内容。

markdown 皮肤简单地输出 markdown 内容。所以这主要用于测试目的。

语法

• 段落和换行
• 标题

段落和换行

段落处理取决于设置的解析器角色（传统 或 gfm）。

如果解析器模式为 传统，则段落是简单的一行或多行连续文本，由一个或多个空白行分隔。

如果解析器模式为 gfm，则上述规则适用，但单行换行符将在同一段落中分隔行。

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a **separate paragraph**.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the **same paragraph**.

这是一行，我们从中开始。

此行通过两个换行符与上面的行分开，因此它将是一个 单独的段落。

此行也是一个单独的段落，但... 此行仅通过单个换行符分隔，因此它是同一段落的单独行。

回到顶部

标题

Markdown 支持两种标题类型（setext 或 atx）。

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1

H2

H3

H4

H5

H6

或者，对于H1和H2，使用类似下划线的样式

Alt-H1
======

Alt-H2
------

Alt-H1

Alt-H2

回到顶部

许可协议

本软件包采用MIT许可证授权

回到顶部