spPress / spPress-core
支持博客的静态网站生成器
v2.2.0
2017-04-13 10:20 UTC
Requires
- php: >=5.5
- michelf/php-markdown: 1.5.*
- pimple/pimple: ~3.0
- symfony/event-dispatcher: 2.7.*
- symfony/filesystem: 2.7.*
- symfony/finder: 2.7.*
- symfony/yaml: 2.7.*
- twig/twig: >=1.8,<2.0-dev
- yosymfony/config-loader: 1.3.*
- yosymfony/embedded-composer: 1.0.*@dev
This package is auto-updated.
Last update: 2024-09-13 04:09:03 UTC
README
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 许可证 的条款提供为开源。