README

一个从Markdown文件生成和缓存页面的网站框架。

功能

该框架目前处于开发阶段，经常发生变化。当准备就绪时，将提供带有标记发布的稳定版本。

composer create-project johnsquibb/markdown-website:dev-main

在开发期间使用内置的PHP服务器从public目录提供服务

php -S localhost:8080 -t public

然后访问：https://:8080 来查看网站。

创建markdown文件并导航网站以创建或更新每个页面的缓存。

要测试静态HTML缓存渲染

php -S localhost:8080 -t cache

然后访问：https://:8080 来查看静态内容。

注意：将public目录中的资源复制到cache目录以在测试静态渲染时查看自定义资源、样式和脚本。

在开发模式下导航页面时，找到的Markdown文件将生成一个网页。包括头部和尾部在内的完整HTML将被渲染成与加载的Markdown文件同名和同目录结构的静态HTML文件。所有相对链接都将添加.html后缀，以方便连接其他缓存内容。

将缓存目录的内容复制到您的网站。只有HTML被缓存。public目录中的任何资源（如CSS、图片等）必须手动复制到您的网站目录。未来的版本可能支持自动复制这些文件。

了解更多关于使用Amazon S3托管静态HTML网站的信息。