mtvee / quill
v0.3.1
2017-12-15 20:48 UTC
Requires
- php: >=5.6 | ^7.0
- erusev/parsedown: ^1.6
Requires (Dev)
- phpunit/phpunit: 5.2.*
This package is auto-updated.
Last update: 2024-09-20 10:24:16 UTC
README
Quill 是一个用 PHP 编写的静态网站生成器。它面向任何可能想保持博客或文档的人。目标是创建一个快速且易于使用的工具。
功能
- 使用 markdown 输入内容
- 布局是 php 文件,因此可以放入任何内容
- 输出为通过 Parsedown 的 html
- 符合 PSR-4 自动加载结构的规范
- 单元测试
要求
- PHP >= 5.6
- composer 很好
安装
以下步骤假设您已安装 composer,并且系统可以访问它。
创建一个文件夹来存储您的项目
$> mkdir FOLDER; cd FOLDER
使用 composer 安装 quill
$> composer require mtvee/quill
或者
$> git clone http://gitlab.com/mtvee/quill $> cd quill $> composer install
让 quill 为您创建一个项目框架
$> vendor/bin/quill create
在 data 目录中构建项目框架
$> vendor/bin/quill build data
html 输出在 public 中,因此我们可以使用 php 运行本地服务器并在网页浏览器中查看输出
$> php -S localhost:8080 -t public/
将 https://:8080 放入浏览器 URL 中,然后 Voila!
您可以从 public 推送到您的实际网站以发布。
下一步
- 在
data中添加/编辑网站源文件 - 在
data/.meta/layout.php中调整布局 - 在
public中添加/编辑您的 css 和 javascript 等 - 将您的文件推送到某个托管服务提供商
- $$利润$$
贡献
许可协议
MIT