@getkist/action-nunjucks

中文文档
2.0.33发布于 2026/10/09MITTypeScriptESM + CJS近 30 天下载 2208

Jinja/ Nunjucks 模板为 kist 提供动作, 并提供单文件和目录模式支持

中文使用文档
文档目录11 节
  1. 特征
  2. 安装
  3. 快速启动
  4. 单文件模式
  5. 目录模式
  6. 文档
  7. 行动
  8. 模板渲染动作
  9. 发展
  10. 所需资源
  11. 许可证

@ getkist/ action- nunjucks (英语)

npm version CI Coverage License: MIT kist plugin

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.html
  • src/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 (韩语)

许可证

麻省理工学院

版本与发布记录

@getkist/action-nunjucks 共发布 8 个版本,首次发布于 2026/02/09;过去 12 个月发布了 8 个版本。

版本发布日期距今
2.0.33latest2026/10/091 个月前
2.0.282026/04/236 个月前
2.0.142026/02/109 个月前
2.0.122026/02/099 个月前
2.0.102026/02/099 个月前
2.0.92026/02/099 个月前

关于 @getkist/action-nunjucks 的常见问题

@getkist/action-nunjucks 是什么?

Jinja/ Nunjucks 模板为 kist 提供动作, 并提供单文件和目录模式支持

如何安装 @getkist/action-nunjucks?

在项目目录运行 npm install @getkist/action-nunjucks,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:kist(>=0.1.58)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@getkist/action-nunjucks 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getkist/action-nunjucks 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@getkist/action-nunjucks 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getkist/action-nunjucks 可以商用吗?

@getkist/action-nunjucks 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@getkist/action-nunjucks 的下载量有多少?

根据 npm 官方下载统计,@getkist/action-nunjucks 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,208 次,日均约 74 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getkist/action-nunjucks 还在维护吗?

最新版本 2.0.33 发布于 2026/10/09(1 个月前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2026/02/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。