首页
/ HOGAN-EXPRESS 技术文档

HOGAN-EXPRESS 技术文档

2024-12-28 01:27:25作者:毕习沙Eudora

本文档旨在帮助用户安装和使用 HOGAN-EXPRESS,一款基于 Mustache 模板引擎和 express 3.x 框架的模板渲染工具。

1. 安装指南

通过 npm 安装 hogan-express:

npm install hogan-express

2. 项目的使用说明

配置

在您的应用配置中,将文件扩展名映射到 hogan-express 引擎。例如:

app.set 'view engine', 'html'    # 使用 .html 扩展名作为模板
app.set 'layout', 'layout'       # 使用 layout.html 作为默认布局
app.set 'partials', foo: 'foo'   # 定义所有页面可用的部分
app.enable 'view cache'
app.engine 'html', require('hogan-express')

渲染模板

在应用路由回调中,定义 res.locals 并调用 res.render,传递模板所需的任何部分。例如:

app.get '/', (req,res)->
  res.locals = name: 'Andrew'
  res.render 'template', partials: {message: 'message'}

这将使用布局 (layout.html,在配置中定义) 渲染模板 (template.html) 和指定的部分 (message.html)。

如果 layout.html 包含:

<p>
  <strong>Message Layout</strong>
  {{{ yield }}}
</p>

并且 template.html 包含:

<em>{{ name }} says {{> message }}</em>

以及 message.html 包含:

Hello World.

回调将生成:

<p>
  <strong>Message Layout</strong>
  <em>Andrew says Hello World.</em>
</p>

layout.html 中的特殊 {{{ yield }}} 变量表示您的布局文件中模板渲染的位置。您可以通过 app.set 'layout', ... 定义布局,或在调用 res.render 时指定。如果不提供布局,模板将直接渲染。

自定义 yield 标签

您可以在 layout.html 中使用自定义标签 {{yield-<name>}} 定义更多扩展点。例如:

布局:

<head>
  ...
  [[[yield-styles]]]
  [[[yield-scripts]]]
  ...
</head>

索引:

[[#yield-styles]]
  <style>
    ...
  </style>
[[/yield-styles]]

[[#yield-scripts]]
  <script>
    ...
  </script>
[[/yield-scripts]]

页面 index.html 将渲染到 {{yield}},但不包括 {{#yield-styles}}...{{/yield-styles}}{{#yield-scripts}}...{{/yield-scripts}} 的内容。这些内容将分别放入 layout.html 中相应命名的标签中。如果 [[[yield-styles]]] 缺失,样式标签内容将不会被渲染。

自定义布局

要使用自定义布局渲染页面,只需在选项中指定即可:

res.render "admin.html", layout: "admin-layout"

自定义 Lambda / 过滤器

要创建自定义过滤器(或 lambda),只需在选项中指定您的过滤器函数:

app.get '/', (req,res)->

  res.locals = myDefaultLabel: "oops" # 这里展示一些作用域的概念

  res.render 'template',
    message: 'This is a message. HERE.'
    mylist: [{label: "one", num: 1},{label: "two", num: 2},{num: 3}]

    lambdas:
     lowercase: (text) ->
       return text.toLowerCase()
     reverseString: (text) ->
       return text.split("").reverse().join("")

模板:

<p>Lowercase <strong>{{message}}</strong>: {{#lambdas.lowercase}}{{message}}{{/lambdas.lowercase}}</p>
<ul>
  {{#mylist}}
  <li>{{num}}: {{label}} is {{#reverseString}}{{label}}{{/reverseString}} in reverse.</li>
  {{/mylist}}
</ul>

渲染的 HTML:

<p>Lowercase <strong>This is a message. HERE.</strong>: this is a message. here.</p>
<ul>
  <li>1: one is eno in reverse.</li>
  <li>2: two is owt in reverse.</li>
  <li>3: oops is spoo in reverse.</li>
</ul>

3. 项目API使用文档

HOGAN-EXPRESS 的 API 使用非常简单,主要涉及以下几个部分:

  • app.set 'view engine', 'html':设置视图引擎为 HTML。
  • app.set 'layout', 'layout':设置默认布局。
  • app.set 'partials', ...:定义部分。
  • app.enable 'view cache':开启视图缓存。
  • app.engine 'html', require('hogan-express'):将 HTML 文件扩展名映射到 Hogan 表达式引擎。
  • res.render ...:渲染视图。

4. 项目安装方式

如安装指南中所述,使用 npm 安装 hogan-express:

npm install hogan-express

以上是关于 HOGAN-EXPRESS 的技术文档,希望对您的使用有所帮助。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
162
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
198
279
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
Git4ResearchGit4Research
Git4Research旨在构建一个开放、包容、协作的研究社区,让更多人能够参与到科学研究中,共同推动知识的进步。
HTML
22
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
950
557
risc-v64-naruto-pirisc-v64-naruto-pi
基于QEMU构建的RISC-V64 SOC,支持Linux,baremetal, RTOS等,适合用来学习Linux,后续还会添加大量的controller,实现无需实体开发板,即可学习Linux和RISC-V架构
C
19
5