README

此软件包允许管理员为Laravel项目开发创建自定义样式指南。

基本元素
从标题、文本、表格等基本元素列表中进行选择。

颜色
提供带有类名、描述和十六进制值的颜色列表。

自定义图案
管理员还可以使用内置的codemirror文本区域创建自定义图案。

安装

此软件包包含3个模型：基本设置、颜色和图案。运行以下命令：

composer require xpersonas/laravel-styleguide
php artisan vendor:publish --tag=xpersonas-styleguide
php artisan migrate

使用

样式指南提供了一个Laravel组件，可以将其添加到任何模板中。这允许您将其添加到页面中，您的样式将应用于样式指南中包含的所有元素。

将其添加到模板中：

<x-styleguide-base />

通过访问您的站点上的 /admin/styleguide 来编辑样式指南设置。

样式表

样式指南包含一个用于布局目的的有限样式表。如果需要，仅将其包含在样式指南页面上。

<link href="{{ asset('css/vendor/xpersonas/styleguide.css') }}" rel="stylesheet" type="text/css" />

保护路由

有几个与CRUD相关的页面需要保护匿名用户。请使用您正在使用的任何认证系统来确保这些页面对公众安全。

// Route setup.
Route::get('admin/styleguide/preview', '\Xpersonas\Styleguide\Http\Controllers\StyleguideController@index')->name('simple-styleguide');

Route::resource('admin/styleguide/patterns','Xpersonas\Styleguide\Http\Controllers\StyleguidePatternController', ['names' => 'pattern'])->middleware(['web']);
Route::resource('admin/styleguide/colors','Xpersonas\Styleguide\Http\Controllers\StyleguideColorController', ['names' => 'color'])->middleware(['web']);
Route::resource('admin/styleguide/basics','Xpersonas\Styleguide\Http\Controllers\StyleguideBasicsController', ['names' => 'basics'])->middleware(['web']);

// Wildcard route to protect.
admin/styleguide/*

Nova已准备好（可选）

https://nova.laravel.net.cn

此软件包是Nova准备的。如果您想在“美观的行政面板”中管理样式指南设置、图案和颜色，请按照以下说明操作。

安装

将我们的Nova工具添加到您的Nova服务提供商

// app/Providers/NovaServiceProvider.php

public function tools()
{
    return [
        new \Xpersonas\Styleguide\Providers\StyleguideNovaTool(),
    ];
}

Laravel Nova颜色字段（可选）

此软件包也与来自timothyasp的优秀Laravel Nova颜色字段兼容。

composer require timothyasp/nova-color-field

贡献

https://github.com/xpersonas/laravel-styleguide/pulls

作者

xpersonas