README

基于Markdown和Nachos的轻量级CMS API

安装

选项1（推荐）：Composer

将此添加到项目的最佳方式是通过Composer安装： composer require pixlmint/pixl-cms

选项2

还可以手动将cms的源代码包含到项目中。为此，您仍然需要在您的网站上启用Composer。在您的 composer.json 文件中，在 autoload > psr-4 下添加 "PixlMint\\CMS\\": "path/to/cms/src" - 重要的部分是冒号之前的部分，否则CMS代码将无法工作

准备好开始工作后，您必须执行 composer dump-autoload

最后（无论是哪种方式）

然后在您网站的根目录下创建一个 index.php 文件

<?php

require __DIR__ . '/vendor/autoload.php';

use PixlMint\CMS\CmsCore;

CmsCore::init();

以下是使用Apache托管网站的基本 .htaccess 配置

<IfModule mod_rewrite.c>
    RewriteEngine On

    # Allow access to these directories and specific files
    RewriteCond %{REQUEST_URI} ^/media/.* [OR]
    RewriteCond %{REQUEST_URI} ^/dist/.* [OR]
    RewriteCond %{REQUEST_URI} ^/public/.* [OR]
    RewriteCond %{REQUEST_URI} ^/backup/.* [OR]
    RewriteCond %{REQUEST_URI} ^/favicon\.ico [OR]
    RewriteCond %{REQUEST_URI} ^/robots\.txt [OR]
    RewriteCond %{REQUEST_URI} ^/manifest\.webmanifest
    # If any of the above conditions are met, do nothing and exit
    RewriteRule ^ - [L]

    RewriteRule ^.*$ index.php [L]
</IfModule>

# Prevent file browsing
Options -Indexes -MultiViews

到此为止！您现在可以随时使用强大的CMS API了。

API文档

在此处查看完整的API文档： PixlCms文档

插件

插件是扩展基础CMS以满足特定需求的好方法。

第一方插件

pixl-wiki

PixlMint Wiki GitHub页面

pixl-journal

PixlMint Journal GitHub页面

pixl-media

一个强大的插件，它添加了媒体上传（图像和视频）的路由，并自动缩放它们

PixlMint Media插件GitHub页面

配置

名称

插件的名称。如果 install_method 设置为 sourcecode，则需要是 plugins 目录内的文件夹名称。

*安装方法

一个字符串，它定义了安装插件的方法。可用选项包括

composer - 如果插件作为Composer插件安装。
sourcecode - 插件位于 /plugins 目录中。

启用

插件是否启用。默认为 true。如果设置为 false，则CMS不会从插件加载任何内容。

配置

插件配置 - 最佳实践是仅使用 require_once 插件的config.php文件。

示例配置

...
[
    'name' => 'pixlcms-journal-plugin',
    'install_method' => 'composer',
    'enabled' => true,
    'config' => require_once('vendor/pixlmint/pixlcms-journal-plugin/config/config.php'),
]
...

插件开发

开始开发插件的最佳方式是查看我的第一方插件之一。

CMS配置

由于PixlCMS是用Nacho框架构建的，因此有关完整配置信息请参阅Nacho Wiki

设置自定义前端控制器

前端控制器是处理所有不指向实际文件（如图像/视频）的路径的控制器，并且不以 /api 开头。

类型： 字符串
默认值： None
配置： base > frontendController

启用调试模式

调试模式通过打印完整的PHP错误来简化插件开发

类型： 布尔值
默认值： false
配置： base > debugEnabled

pixlmint/pixl-cms

维护者

详细信息