pixelbrackets/html5-mini-template

HTML5 Mini Template，用于快速渲染状态页面、目录页面或任何其他最小化单服务网站

维护者

详细信息

gitlab.com/pixelbrackets/html5-mini-template

源代码

问题

安装次数: 9,966

依赖关系: 6

建议者: 0

安全性: 0

星级: 0

分支: 0

2.3.0 2022-11-10 11:06 UTC

Requires (Dev)

GPL-2.0-or-later 3e5f034935726421bbacda113216e64882345fd2

This package is auto-updated.

Last update: 2024-09-10 15:05:40 UTC

README

Version Build Status Made With License Contribution

HTML5 Mini Template，用于快速渲染状态页面、目录页面或任何其他最小化单服务网站。

Screenshot

⭐ 您喜欢这个包吗？请给它加星或发送一条推文。 ⭐

愿景

此包提供了一个类，将消息或HTML片段转换为有效的HTML5文档。

这样，应用程序就可以在没有预先存储模板文件或初始化完整模板引擎的情况下返回HTML响应。

因此，该包没有模板变量或修饰符。两行代码就足以将给定文本包裹在有效的HTML文档中。再加一行来添加一个链接到花哨的样式表。

请参阅»用法«以获取一些示例。

该包遵循KISS原则。

Web应用

此包用于html5example.com。

如果您只需一次使用样板HTML文档，则可以使用cURL或HTTPie等命令行工具并运行http https://html5example.com > index.html以保存模板文件。

该Web应用还支持此包的一些选项，例如http POST https://html5example.com title=Minimal-Template > index.html以传递自定义标题。

要求

  • PHP

安装

Packagist条目 https://packagist.org.cn/packages/pixelbrackets/html5-mini-template/

源代码

https://gitlab.com/pixelbrackets/html5-mini-template/

镜像 https://github.com/pixelbrackets/html5-mini-template/（问题与拉取请求已镜像到GitLab）

演示

⌨️ php tests/demo.php。

用法

  1. 将消息包裹在HTML5文档中，返回到PSR-7实现

    $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
$template->setContent('<h1>Status</h1><p>All Systems Operational</p>');
return $template->getMarkup();

  2. 将消息包裹，使用预配置的CSS框架CDN（请参阅»选项«以获取支持的框架列表），并将文档保存到文件中

    $template = new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate();
$template->setStylesheet('barbone');
$template->setContent('<h1>Index</h1><p>Nothing to see here</p>');
file_put_contents('/var/www/example/index.html', $template->getMarkup());

  3. 将消息包裹，设置自己的样式表URL，设置标题，输出文档

    $template = (new \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate())
    ->setStylesheet('/assets/styles.css')
    ->setTitle('Index')
    ->setContent('<h1>TOC</h1><ul><li>a</li><li>b</li></ul>');
echo $template->getMarkup();

  4. 仅获取样板示例模板（👉或使用Web应用）

    echo \Pixelbrackets\Html5MiniTemplate\Html5MiniTemplate::getTemplate();

选项

  • setContent() (string) 要显示的消息，任何HTML字符串都可以设置文档的主内容 – 如果为空，则使用样板示例内容
  • setStylesheet() (string) 可以是任何现有样式表的URL 或 以下保留关键字之一 – 每个关键字都会创建一个指向相关CSS框架CDN的链接
  • setStylesheetMode() (字符串) 在给定的样式表链接（使用常量 Html5MiniTemplate::STYLE_LINK，这是默认模式）或获取样式表文件内容并内联打印（使用常量 Html5MiniTemplate::STYLE_INLINE）之间切换
  • setTitle() (字符串) 文档标题 – 如果为空，则使用主内容中找到的第一个 H1 标题作为标题
  • setAdditionalMetadata() (字符串) 任何附加元数据，如元标签、自定义样式或链接引用，如规范链接
    • ⚠️ 使用此选项是给定用例过于具体的一个指标，应考虑切换到模板引擎，如最小化的 slim/php-view 或强大的 twig/twig

许可证

GNU 通用公共许可证版本 2 或更高版本

GNU 通用公共许可证可在 https://gnu.ac.cn/copyleft/gpl.html 找到。

作者

Dan Untenzu (mail@pixelbrackets.de / @pixelbrackets)

变更日志

查看 CHANGELOG.md

贡献

此脚本是开源的，请使用、分享、修复、扩展或分支它。

贡献 欢迎加入！

反馈

请提供一些 反馈 并分享此包如何对您有益或您如何帮助改进它。