spPress/spPress-core

支持博客的静态网站生成器

v2.2.0 2017-04-13 10:20 UTC

README

Build Status Scrutinizer Code Quality SensioLabsInsight

spPress 是一个基于 Symfony 组件和默认模板引擎 Twig 构建的静态网站生成器。此存储库是 spPress 应用程序的核心。

安装

转到您的应用程序文件夹,并输入以下命令

composer require spress/spress-core

如何使用?

入口点类为 Yosymfony\Spress\Core\Spress。以下示例说明了如何使用

use Yosymfony\Spress\Core\Spress;

class MyClass
{
    public function parseSite()
    {
        $spress = new Spress();
        $spress['spress.config.site_dir'] = '/path-to-your-spress-site';
        $spress->parse();
    }
}

包含草稿帖子

use Yosymfony\Spress\Core\Spress;

class MyClass
{
    public function parseSite()
    {
        $spress = new Spress();
        $spress['spress.config.site_dir'] = '/path-to-your-spress-site';
        $spress['spress.config.drafts'] = true;
        $spress->parse();
    }
}

其他配置值

  • $spress['spress.config.env']:默认环境名称为 dev。此选项确定配置文件,如果您为该环境名称有特定的配置文件。例如:$spress['spress.config.env'] = 'prod'
  • $spress['spress.config.safe']:使用 true 禁用所有插件。例如:$spress['spress.config.safe'] = true
  • $spress['spress.config.drafts']:在转换中包含草稿帖子。默认为 false
  • $spress['spress.config.url']:设置基本 URL。
  • $spress['spress.config.timezone']:设置时区。例如:"Europe/Madrid"。

单元测试

spPress 核心使用 PHPUnit >= 5.7。您可以使用以下命令运行单元测试

$ cd your-path
$ phpunit

许可

此库根据 MIT 许可证 的条款提供为开源。