README

A Laravel PHP Composer 包，用于包含 The PHP Leagues CommonMark 实现 的有用 CommonMark 扩展。

• Laravel 有用 CommonMark 扩展
  • 入门指南
    • 先决条件
    • 安装
      • 安装 Composer 包
      • 将 Markdown 扩展添加到配置文件中
  • 运行测试
  • Wiki
    • Markdown 特性
      • Gist
      • Codepen
      • SoundCloud
      • YouTube
      • 颜色
      • 文本对齐
  • 贡献
  • 许可

入门指南

安装此扩展到您的 Laravel 项目的说明。

先决条件

• PHP >= 7.1
• Laravel >= 5.5 + 或 6.0 +

安装

按照以下步骤，使此 CommonMark 扩展在您的 Laravel 项目中运行！

安装 Composer 包

在您的 Laravel 项目根目录（其中存在 package.json）运行以下命令。

$ composer require johnnyhuy/laravel-useful-commonmark-extension

将 Markdown 扩展添加到配置文件中

在 config/markdown.php 中的 extensions 数组中添加 JohnnyHuy\Laravel\UsefulCommonMarkExtension::class。以下是一个示例

'extensions' => [
    ...
    JohnnyHuy\Laravel\UsefulCommonMarkExtension::class
    ...
],

运行测试

克隆此仓库并运行 composer install 以安装所有相关的 Composer 包。更改根扩展目录，并运行以下命令以执行 PHPUnit 测试用例。

$ vendor/bin/phpunit tests/

Wiki

我已编写了一个 Wiki 页面来描述此扩展的功能。

Markdown 特性

Gist

:gist https://gist.github.com/noxify/2b02fd0fb0ea18a4d9d764e31fe9af8e

Codepen

:codepen https://codepen.io/YusukeNakaya/pen/XyOaBj

SoundCloud

:soundcloud https://soundcloud.com/djtechnoboy/tnt-sound-rush-right-now

更多信息

YouTube

:youtube https://www.youtube.com/watch?v=pwmY1XUTBpE

更多信息

颜色

# Worded colors
:color red
Hello I should be in red text :D
:color

:color-red this is inline! :color

# 3 Character hex
:color #AAA
Hello!
:color

:color-#AAA this is inline! :color

# 6 Character hex
:color #DADADA
Hello!
:color

:color-#DADADA this is inline! :color

# RGB
:color 255,255,255
Hello!
:color

:color-255,255,255 this is inline! :color

# RGBA
:color 255,255,255,50
Hello!
:color

:color-255,255,255,50 this is inline! :color

更多信息

文本对齐

# Center alignment
:text-center
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean tincidunt urna maximus sem congue, viverra ultrices purus porta. Aenean at porta mi. Donec ut felis consectetur, rutrum mauris non, sagittis ipsum. Quisque sit amet fringilla lorem. Curabitur euismod imperdiet nunc, et vehicula lorem scelerisque et. Fusce rutrum id lectus in pellentesque. Donec vel cursus dolor. Ut placerat justo nunc, a imperdiet libero posuere non. Nullam dolor ligula, efficitur a accumsan non, viverra quis lorem. Mauris at auctor ligula.
:text-center

# Right alignment
:text-right
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean tincidunt urna maximus sem congue, viverra ultrices purus porta. Aenean at porta mi. Donec ut felis consectetur, rutrum mauris non, sagittis ipsum. Quisque sit amet fringilla lorem. Curabitur euismod imperdiet nunc, et vehicula lorem scelerisque et. Fusce rutrum id lectus in pellentesque. Donec vel cursus dolor. Ut placerat justo nunc, a imperdiet libero posuere non. Nullam dolor ligula, efficitur a accumsan non, viverra quis lorem. Mauris at auctor ligula.
:text-right

# Left alignment
:text-left
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean tincidunt urna maximus sem congue, viverra ultrices purus porta. Aenean at porta mi. Donec ut felis consectetur, rutrum mauris non, sagittis ipsum. Quisque sit amet fringilla lorem. Curabitur euismod imperdiet nunc, et vehicula lorem scelerisque et. Fusce rutrum id lectus in pellentesque. Donec vel cursus dolor. Ut placerat justo nunc, a imperdiet libero posuere non. Nullam dolor ligula, efficitur a accumsan non, viverra quis lorem. Mauris at auctor ligula.
:text-left

更多信息

贡献

• 项目基于 Graham Campbell 的 emoji 解析器（用于 Laravel）
• Johnny Huynh - 初始更改

许可

本项目采用 MIT 许可协议，有关更多信息，请参阅 LICENSE。

• league/commonmark 采用 BSD-3 许可协议
• GrahamCampbell/Laravel-Markdown 采用 MIT 许可协议
• AltThree/Emoji 采用 MIT 许可协议