@ getkist/ action- nunjucks (英语)
Jinja/ Nunjucks 模板为 键 构建工具.
特征
- QQ 文件的 Render Nunjucks 模板
- 📁 目录模式 - 批量渲染整个文件夹保存结构
- QQ 从 YAML/ JSON 文件装入上下文数据
- * 配置 Nunjucks 行为(自动逃生、修剪、脱口而出)
- 自定义输出编码支持
- 用于文档站点、静态页面和代码源
安装
npm install --save-dev @getkist/action-nunjucks
快速启动
单文件模式
pipeline:
stages:
- name: render
steps:
- name: render-page
action: TemplateRenderAction
options:
templatePath: ./templates/page.njk
outputPath: ./dist/page.html
context:
title: "Welcome"
目录模式
在保存文件夹结构的同时将所有模板编成目录 :
pipeline:
stages:
- name: render
steps:
- name: render-templates
action: TemplateRenderAction
options:
inputDir: ./src/templates
outputDir: ./dist
pattern: "**/*.html.jinja"
excludePatterns:
- "_*.jinja"
- "partials/**"
stripExtension: ".jinja"
context:
siteName: "My Site"
这使得:
src/templates/index.html.jinja→dist/index.htmlsrc/templates/about/team.html.jinja→dist/about/team.html- 跳过
_base.jinja财务报告和审定财务报表partials/文件
文档
行动
模板渲染动作
有可选上下文文件和Nunjucks配置的Renders Nunjucks模板.
单一文件模式选项
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
templatePath | 字符串 | 对 | 模板文件路径 |
outputPath | 字符串 | 对 | 输出文件路径 |
context | 对象 | 没有 | 模板上下文数据 |
contextFiles | 字符串 [] | 没有 | 要合并的 YAML/ JSON 文件 |
searchPaths | 字符串 [] | 没有 | 包括的模板搜索路径 |
autoescape | 布尔 | 没有 | 启用 HTML 出逃 |
trimBlocks | 布尔 | 没有 | 从区块调整新线 |
lstripBlocks | 布尔 | 没有 | 从块中剥去领导空白 |
outputEncoding | 字符串 | 没有 | 文件编码( 默认: utf8) |
目录模式选项
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
inputDir | 字符串 | 对 | 包含模板的源目录 |
outputDir | 字符串 | 对 | 已渲染文件输出目录 |
pattern | 字符串 | 没有 | Glob 模式( 默认 ): **/*.html.jinja(中文(简体) ) |
excludePatterns | 字符串 [] | 没有 | 应予排除的模式(例如部分) |
stripExtension | 字符串 | 没有 | 删除扩展( 默认 ): .jinja(中文(简体) ) |
context | 对象 | 没有 | 共享所有模板的上下文 |
contextFiles | 字符串 [] | 没有 | 要合并的 YAML/ JSON 文件 |
searchPaths | 字符串 [] | 没有 | 包括的模板搜索路径 |
autoescape | 布尔 | 没有 | 启用 HTML 出逃 |
trimBlocks | 布尔 | 没有 | 从区块调整新线 |
lstripBlocks | 布尔 | 没有 | 从块中剥去领导空白 |
outputEncoding | 字符串 | 没有 | 文件编码( 默认: utf8) |
发展
npm run build # Compile TypeScript
npm run test # Run tests
npm run lint # Check code quality
npm run docs # Generate API documentation
npm run format # Format code with Prettier
所需资源
- 节点.js 22.0.0
- npm = 10.0.0 (韩语)
许可证
麻省理工学院