buzzylab/laradown

基于 parsedown 的 Laravel 新 Markdown 解析器

维护者

详细信息

github.com/buzzylab/laradown

源代码

问题

安装次数: 7,172

依赖者: 0

建议者: 0

安全: 0

星标: 29

关注者: 4

分支: 3

开放问题: 1

语言：CSS

v0.2.1 2020-09-17 09:51 UTC

Requires

MIT 85f6f7ab1dc7a582c551e50a7c1a6d75b9dc66d7

  • buzzylab <buzzyllab.woop@gmail.com>
  • maher el gamil <maherbusnes.woop@gmail.com>

packagemarkdowneditorlaravel

This package is auto-updated.

Last update: 2024-09-17 18:02:37 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License StyleCI

一个基于 Parsedown 和 Parsedown Extra 的新 Laravel Markdown 解析器。

安装

安装此包最好的方法是使用 Composer。

兼容性

此包完全兼容 Laravel 5.4 以上的版本。

所需包

打开您的应用程序的 composer.json 文件，并将以下行添加到 require 数组中

"buzzylab/laradown": "~0.2"

注意：确保在应用更改后，通过运行 composer validate 确保您的 composer.json 文件是有效的。

安装包后，打开位于 config/app.php 的 Laravel 配置文件，并将以下服务提供者添加到 $providers 数组中

Buzzylab\Laradown\MarkdownServiceProvider::class,

注意：请参阅 Laravel 的 服务提供者 和 服务容器 文档以获取更多信息。

并将以下内容添加到 $aliases

'Markdown' => Buzzylab\Laradown\Facades\MarkdownFacade::class

使用方法

<?php

echo Markdown::render(); // OR echo Markdown::convert();

以上步骤即可。

Blade 指令

使用带参数的 @markdown 指令

@extends('layouts.master')

@section('content')
<div>
    
  {{-- $content is markdown data --}}
  @markdown($content)
</div>
@stop

使用 @markdown 和 @endmarkdown 作为指令块

@extends('layouts.master')

@section('content')
<div>
  @markdown
  
  # Laradown Packag
  
  @endmarkdown
</div>
@stop

使用 @markdownstyle 为转换后的 HTML 添加样式

    {{-- Get defaute style file --}}
    @markdownstyle
    
    {{-- Custom style file --}}
    @markdownstyle($file)

辅助函数

markdown($markdown)

将 Markdown 内容转换为 HTML

markdown_style()

为转换后的 HTML 添加样式

许可

本软件根据 MIT 许可证 (MIT) 发布。