README

简介

Preacher 是一个个人静态网站生成器，允许您无需配置即可设置和维护个人网站。

要使用 Preacher 创建全新网站，可以按照以下步骤安装

composer create-project zero-config/static-website

当被询问是否删除现有版本控制系统时，回答 Y。

composer require --dev zero-config/preacher

这将安装必要的文件和包。下一步是初始化 git 仓库，这样 Preacher 就可以跟踪需要发布的内容

git init

现在我们只需提交我们的第一个页面和模板

git add index.md default.html.twig && git commit -m "My first Preacher page!"

要了解基本的 .md 页面文件和模板可以包含什么，请查看 Preacher 自身的 index.md 页面和 default.html.twig 模板。

默认情况下，Preacher 会寻找名为 default.html.twig 的 Twig 模板。但是，如果需要自定义模板，只需将其命名为与源文件相同的名称即可。

例如： articles/something-fancy.md => articles/something-fancy.html.twig。

Preacher 从提交的 .md 页面文件和 .twig 模板创建页面。它使用单个命令来生成当前目录及其所有子目录，或者可以（重新）生成单个源文件。

vendor/bin/preach [<source>]...

可选地，如果希望在文件提交时始终生成输出，请尝试以下操作

ln -s ../../vendor/bin/preach .git/hooks/post-commit

这将安装 Preacher 作为 post-commit 钩子，并使其在您提交文件时运行。

通过解析 vendor-dir composer 配置跳过 vendor 目录的内容。

如果想要强制生成文件，请添加 --force 标志。

Preacher 使用具有良好定义标准的现有软件来创建最稳定和用户友好的体验。

Preacher 是为程序员构建的。

有关 Preacher 的完整文档和食谱，请访问 Preacher 主页。