selene软件 / staticsite
Requires
- aptoma/twig-markdown: ^3.2
- erusev/parsedown: ^1.7
- symfony/yaml: ^4.3
- twig/twig: ^2.11
This package is auto-updated.
Last update: 2024-08-29 04:58:01 UTC
README
一个由Twig和Markdown构建的相对较小的静态站点构建工具,不是以博客为中心的。
入门指南
以下说明将帮助您在本地机器上运行项目副本以进行开发和测试。有关如何在实际系统上部署项目的说明,请参阅部署部分。
先决条件
Composer npm/Yarn PHP 7.2+
安装
一系列逐步示例,说明如何设置开发环境
说明步骤将是什么
composer create-project selenesoftware/seleneSite
运行测试
解释如何运行此系统的自动化测试。我没有为这个系统编写测试。它如此之小,测试似乎比实际代码更大。不想那样。
代码风格
实际构建器和骨架的代码由PHP CS Fixer(friendsofphp/php-cs-fixer)检查。有一个.php_cs.dist文件,其中包含Selene软件通常运行的规则。请随意根据您自己的风格指南进行调整。
php-cs-fixer fix
部署
运行bin/app.php后,在'web'目录中创建文件。然后运行npm run build,您就有生产就绪的文件了。将'web'目录中的所有内容放入您的生产环境中。
构建工具
- Twig - 使用的渲染引擎
- Composer - 依赖管理
- Symfony Encore - 资产捆绑
贡献
请阅读CONTRIBUTING.md以了解我们的行为准则以及向我们的提交拉取请求的过程。
提交拉取请求时,请确保您是向具有下一个版本号的特性分支提交。如果您的拉取请求仅包含文档,请随意对master分支进行拉取。
提交时,请更新以下作者的章节。
版本控制
我们使用SemVer进行版本控制。有关可用版本,请参阅此存储库的标签。我们还尝试使骨架与lib的版本相同。
升级
我们尽量在版本之间尽可能少地修改骨架,因为插件是在应用程序文件中构建的。但为了升级库,只需更新composer即可。
composer update
作者
- Jason Marshall - 初始工作 - psion
许可
此项目采用Apache License许可 - 有关详细信息,请参阅LICENSE-2.0.md文件。