feat(readme): 更新文档和配置注释

This commit is contained in:
coolzr
2025-10-19 00:24:03 +08:00
parent aa264cc727
commit 9e2a8b0da4
10 changed files with 221 additions and 54 deletions

View File

@@ -50,6 +50,19 @@ MeNav 的助手函数分为四类:
- 空值检查
- 逻辑运算(与、或、非)
#### ifHttpUrl
判断字符串是否为 http/https URL用于在模板中分支渲染仅对外链生效的逻辑如 favicon 加载):
```handlebars
{{#ifHttpUrl url}}
{{!-- 只有 http/https 才尝试加载 favicon --}}
<img src="https://t3.gstatic.com/faviconV2?url={{encodeURIComponent url}}&size=32" alt="{{name}} favicon" />
{{else}}
<i class="fas fa-link"></i>
{{/ifHttpUrl}}
```
### 工具函数
位置:`src/helpers/utils.js`
@@ -61,6 +74,15 @@ MeNav 的助手函数分为四类:
- 范围数组生成
- 对象属性选择
#### encodeURIComponent
对字符串进行 URL 组件编码(同名于浏览器 API用作模板内联助手适用于将动态 URL 参数安全拼接到查询串:
```handlebars
{{!-- 构造第三方 Favicon API 的 url 参数 --}}
<img src="https://t3.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&url={{encodeURIComponent url}}&size=32" alt="favicon" />
```
### 核心函数
位置:`src/helpers/index.js`
@@ -379,4 +401,4 @@ function registerAllHelpers(handlebars) {
4. **避免副作用** - 助手函数应为纯函数,不修改传入的数据
5. **保持简单** - 每个助手函数应只完成一个明确的任务
5. **保持简单** - 每个助手函数应只完成一个明确的任务