For AI agents: the complete documentation index is available at https://docs.halo.run/llms.txt, the full documentation bundle is available at https://docs.halo.run/llms-full.txt, and this page is available as Markdown at https://docs.halo.run/developer-guide/theme/static-resources.md.

静态资源

通过 目录结构 的讲解我们可以知道,目前主题的静态资源统一托管在 /templates/assets/ 目录下,下面讲解一下如何在模板中使用,大致会分为两种引入方式。

模板标签引用

<link rel="stylesheet" th:href="@{/assets/dist/style.css}" />
<script th:src="@{/assets/dist/main.iife.js}"></script>

<img th:src="@{/assets/images/logo.png}" />

其中 @{/assets/dist/style.css} 表示引用 /templates/assets/dist/style.css 文件。最终会被渲染为:

<link rel="stylesheet" href="/themes/my-theme/assets/dist/style.css" />

API 引用

以上方式仅支持在 HTML 标签中使用,且必须使用 @{} 包裹才能渲染为正确的路径。如果需要在非 HTML 标签中得到正确的路径,我们提供了 #theme.assets() API。

资源地址无需包含 /assets/

需要注意的是,调用 #theme.assets() 的时候,资源地址不需要添加 /assets/

比如我们需要在 JavaScript 中异步获取一些资源:

<script th:inline="javascript">
  loadScript('[(${#theme.assets("/dist/main.iife.js")})]');

  // loadScript('/themes/my-theme/assets/dist/main.iife.js');

  function loadScript(url) {
    return new Promise(function (resolve, reject) {
      var script = document.createElement("script");
      script.type = "text/javascript";
      script.src = url;
      script.onload = resolve;
      script.onerror = reject;
      document.head.appendChild(script);
    });
  }
</script>
在 JavaScript 中使用 Thymeleaf

关于在 JavaScript 中使用 Thymeleaf 语法可以参考 Thymeleaf 官方文档:JavaScript inlining

#theme.route(path)

#theme.assets() 类似,#theme.route() 用于在非 HTML 标签的场景下得到站点内某个路由的正确地址,路径会基于当前站点的外部访问地址或上下文路径构建:

引入版本:2.4.0

<script th:inline="javascript">
  var archivesUrl = '[[${#theme.route("/archives")}]]';

  // archivesUrl 为 '/archives'
</script>