shawnsandy/pagekit

Laravel Ui.Pages

v1.0.73 2017-04-12 16:00 UTC

README

SensioLabsInsight Codacy Badge

Pages (ui-pages) 是一个简单易用的 Laravel 默认 "欢迎页面" 的嵌入式替代 UI。它提供了一套干净、现代的与 Bootstrap 兼容的启动页面 -- 首页、关于、联系以及一个启动管理仪表板模板。同时还有一个静态的扁平文件系统,可以快速添加和使用 Markdown 文件作为内容。设置、配置和定制快速简单,让您能够在几分钟内部署和启动基于 Laravel 的静态营销/推广网站,以便您能专注于开发。

首页屏幕截图

Pages Screenshot

管理仪表板(黑雾版)

管理仪表板将变为独立的包(已弃用)

PageKit

如果您在寻找原始的 PageKit 包,您仍然可以在Pagekit 原始处找到它。我已经将 PageKit 移动到新的仓库并更改了名称,以避免与 PageKit CMS 冲突。我还利用这个机会重新启动了版本控制,以更好地满足 semver 标准。对此造成的不便表示歉意,希望您觉得这个包很有用。

安装(传统方式)

Laravel 5.5.*(后续版本)


composer require shawnsandy/pagekit dev-master

Laravel 5.4.*(早期版本)


composer require shawnsandy/pagekit

PageKitServiceProvider

将 PageKitServiceProvider 添加到 config/app.php 中的 providers 数组

    ShawnSandy\PageKit\PageKitServiceProvider::class

添加以下(必需)的供应商服务提供商和预安装的 Laravel 包的别名。

供应商服务提供商 config/app/php

        Rap2hpoutre\LaravelLogViewer\LaravelLogViewerServiceProvider::class,
        JeroenG\Packager\PackagerServiceProvider::class,
        Sven\EnvProviders\EnvServiceProvider::class,
        Barryvdh\Debugbar\ServiceProvider::class,
        Brotzka\DotenvEditor\DotenvEditorServiceProvider::class,
        Laravel\Socialite\SocialiteServiceProvider::class,
        Vinkla\Shield\ShieldServiceProvider::class,

供应商别名

    'DotenvEditor' => Brotzka\DotenvEditor\DotenvEditorFacade::class,
    'Breadcrumbs' => ShawnSandy\PageKit\Facades\BreadcrumbFacade::class,
    'MD' => ShawnSandy\PageKit\Facades\MarkdownFacade::class,
    'Socialite' => Laravel\Socialite\Facades\Socialite::class,
    'Debugbar' => Barryvdh\Debugbar\Facade::class,

如果您想使用 Markdown 为文章,请在 config/filesystem.php 中添加以下内容

        'markdown' => [
            'driver' => 'local',
            'root' => storage_path('app/public/markdown/'),
            'visibility' => 'public',
        ],

中间件 app/Http/Kernel.php routeMiddlware

    'shield' => \Vinkla\Shield\ShieldMiddleware::class,

route/web.php 中添加以下内容

Route::group(["prefix" => "page"], function () {
        Pages::routes();
    });

发布供应商文件/资源

您可以发布所有供应商文件,或者只需发布包资源(样式/JS/图片)

所有文件

php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider"

资源

php artisan vendor:publish --tag=pagekit-assets

发布标签

您可以使用 --tags 选项发布单个 PageKit 标签,请注意--pagekit-assets 标签对于页面正确显示是必需的。顺便说一句,这是我的首选安装方法

php artisan vendor:publish --provider="ShawnSandy\PageKit\PageKitServiceProvider"

或快捷方式

php artisan vendor:publish --tag=name

PageKit 标签

  • --tag=pagekit-assets 将您的 PageKit 公共资源/文件发布到 /public/
  • --tag=pagekit-views 将您的视图发布到 vendor\pagekit
  • --tag=pagekit-config 将配置文件 config\pagekit 发布到 config

您还可以使用 --force 覆盖之前发布的文件 - --tag=pagekit-assets --force

为自定义/包开发安装

要定制或使用此包开始自己的项目。

  • 安装 Laravel Packager composer require jeroen-g/laravel-packager。请确保将提供者添加到您的 config/app.php 提供者数组 JeroenG\Packager\PackagerServiceProvider::class,
  • 导入仓库 php artisan packager:git https://github.com/shawnsandy/pagekit YourVendorName YourPackgeName。这将创建并下载包到 /packages/YourVendorName/YourPackageName。它还将您的包添加到 composer 自动加载参数,并将其添加到 config/app.php 提供者数组。
  • 自定义并推送到您的仓库
  • 享受

用法

安装正确后,您应该能够访问 http://yoursite.com/page

默认索引页面

通过修改您的 app/Http/routes.php,用 PageKit 索引替换默认的 welcome 页面

Route::get('/', function () {
    return view('welcome');
});

  Route::get('', function(){
        return view('page::index');
    });

启用登录仪表板

默认情况下,Pages 不需要数据库,因此您的管理员仪表板不需要登录。但是,您可以使用包含在 Pages 中的 Laravel Shield 包来启用无状态登录。

请确保您已将提供者添加到您的 config\app.php(供应商提供者)中。


Vinkla\Shield\ShieldServiceProvider::class,

将中间件添加到 Kernel.php 文件中的 $routeMiddleware 数组。


'shield' => \Vinkla\Shield\ShieldMiddleware::class,

使用提供者标签发布供应商资产。


php artisan vendor:publish --provider="Vinkla\Shield\ShieldServiceProvider"

使用 `php artisan vendor:publish` 可能会产生一些意外的效果,不要这样做!!!

运行 php artisan 命令以生成您的 shield 密码 php artisan shield:hash username password

将密码添加到您的 '/config/shield.php' 文件中


  'users' => [
        'main' => ['$2y$10$wBoPEW4WJO5kTlzwkF4vw.hfGnImJV2kla4UALPNKhMLEoYUWDFL6',
            '$2y$10$kk9u9VdzoXAh/hL/sy6BFuUP.Prf/761rbuPMVhCBaXsYKgymS232'],
    ],

访问 Laravel Shield 获取更多信息。

Laravel .ENV 编辑器

用于编辑 .env 文件设置

php artisan vendor:publish --provider="Brotzka\DotenvEditor\DotenvEditorServiceProvider"

组件

联系表单

{{ Html::pageContactForm() }}

页面导航

{{ Html::pageNav() }}

页面封面

{{ Html::pageCover('/background/img', '500px') }} // background image, height

自定义品牌

您可以通过编辑 config/pagekit.php 中的值来自定义 Pagekit。

开启品牌

    'branding' => true,

自定义

'brand' => [
    'background-color' => '#FFFFFF',
    'header-background-color' => '#EEEEEE',
    'header-font-size' => '72px',
    'font-family' => '"Helvetica Neue", Helvetica, Arial, sans-serif',
    'header-font-color' => '#eee',
    'footer-background-color' => '#333333',
    'footer-color' => '#FFFFFF',
    'header-color' => '#EEEEEE',
    'text-color' => 'FFFFFF',
    'header-background-image' => "https://static.pexels.com/photos/129569/pexels-photo-129569-large.jpeg",
    'logo' => false
]

自定义页眉

header-background-image' => "https://static.pexels.com/photos/129569/pexels-photo-129569-large.jpeg",

'Custom Header Background'

待办事项

...

贡献

复制它!创建您的功能分支:git checkout -b my-new-feature 提交您的更改:git commit -am '添加一些功能' 推送到分支:git push origin my-new-feature 提交拉取请求 :D 历史

变更日志

v.1.0.1

重命名了包并移动了存储库

Pagekit 更新日志

许可证

待办事项:修改 licence.md

此项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE.md 文件