itsjavi / flatdown
此包已被弃用且不再维护。未建议替换包。
具有 Markdown 支持的极简扁平文件 CMS,用 PHP 编写。
0.6.0
2017-05-26 07:38 UTC
Requires
- php: ^5.6 || ^7.0
- cebe/markdown: ~1.1.1
- http-interop/http-middleware: ^0.4
- itsjavi/philae: ^0.5
- league/plates: ~3.3.0
- middlewares/error-handler: ~0.6.0
- middlewares/utils: ~0.11.1
- symfony/yaml: ~3.2.7
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.3
- phpunit/phpunit: ^5.7
- squizlabs/php_codesniffer: ^2.8
This package is not auto-updated.
Last update: 2020-01-24 16:39:55 UTC
README
具有 Markdown 支持的极简扁平文件 CMS,用 PHP 编写。
本项目符合 PSR-1、PSR-2、PSR-4、PSR-7、PSR-11 和 PSR-15。如果您发现合规性问题,请通过拉取请求发送补丁。
亮点
- 非常适合本地和内容丰富的微站:文档、个人笔记、食谱等。
- 无需设置
- 无管理员,但有配置文件
- 无数据库,但有 Markdown 文件
- 无模板引擎,但有纯 PHP(使用 Plates)
- 无复杂的路由逻辑。您的内容文件夹结构 = 您的 URL。
- 无复杂或过度设计的代码,易于用作基础项目
- 熟悉的项目结构(受 Laravel 启发)
- 熟悉的开源组件和模式
- 内部结构
- League Container 作为应用程序的核心(支持 PSR-11)
- League Plates 作为纯 PHP 模板引擎
- Zend Diactoros 作为 PSR-7 HTTP 消息实现
- 基于 FastRoute 的 PSR-7 路由引擎
- 支持 PSR-15 中间件,包括 request-handler
- 支持 Extra 和 Github 风格的 Markdown,还支持 YAML 风格的元数据。
- 包含 Docker 文件,可快速搭建开发环境
安装
通过 Composer
$ composer create-project itsjavi/flatdown flatdown ~0.5
通过命令行
$ git clone https://github.com/itsjavi/flatdown.git && cd flatdown && composer install
在浏览器中打开
$ ./serve -o
需求
- PHP >= 5.6
- Composer
- Docker(可选)
文档
Markdown 示例文件: public/content/demo.md
目录
public/content
:Markdown 文件所在的目录public/assets
:包含不同前端资源的目录(css、img、js、...)resources/views
:主要布局和不同视图的目录
命令
./serve
:使用内置 PHP HTTP 服务器提供项目。使用-o
选项在浏览器中打开。docker-compose up
:与serve
相同,但使用最新版本的容器化 PHP
测试
$ composer test
或
$ vendor/bin/phpunit $ vendor/bin/phpcs
贡献
请参阅CONTRIBUTING以获取详细信息。
鸣谢
- Carsten Brandt (Cebe Markdown)
- Oscar Otero (PSR-7 中间件)
- Nikita Popov (FastRoute)
- 所有贡献者
许可证
MIT 许可证 (MIT)。请参阅许可证文件获取更多信息。