@getkist/action-nunjucks

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

Jinja/Nunjucks template rendering actions for kist with single-file and directory mode support

原始使用文档
文档目录11 节
  1. Features
  2. Installation
  3. Quick Start
  4. Single File Mode
  5. Directory Mode
  6. Documentation
  7. Actions
  8. TemplateRenderAction
  9. Development
  10. Requirements
  11. License

@getkist/action-nunjucks

npm version CI Coverage License: MIT kist plugin

Jinja/Nunjucks template rendering actions for kist build tool.

Features

  • 🎨 Render Nunjucks templates to files
  • 📁 Directory mode - batch render entire folders preserving structure
  • 📝 Load context data from YAML/JSON files
  • ⚙️ Configurable Nunjucks behaviors (autoescape, trim, lstrip)
  • 🔤 Custom output encoding support
  • 🚀 Useful for docs sites, static pages, and codegen

Installation

npm install --save-dev @getkist/action-nunjucks

Quick Start

Single File Mode

pipeline:
    stages:
        - name: render
          steps:
              - name: render-page
                action: TemplateRenderAction
                options:
                    templatePath: ./templates/page.njk
                    outputPath: ./dist/page.html
                    context:
                        title: "Welcome"

Directory Mode

Render all templates in a directory while preserving folder structure:

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"

This renders:

  • src/templates/index.html.jinja → dist/index.html
  • src/templates/about/team.html.jinja → dist/about/team.html
  • Skips _base.jinja and partials/ files

Documentation

Actions

TemplateRenderAction

Renders Nunjucks templates with optional context files and Nunjucks configuration.

Single File Mode Options

OptionTypeRequiredDescription
templatePathstringYesPath to template file
outputPathstringYesOutput file path
contextobjectNoTemplate context data
contextFilesstring[]NoYAML/JSON files to merge
searchPathsstring[]NoTemplate search paths for includes
autoescapebooleanNoEnable HTML escaping
trimBlocksbooleanNoTrim trailing newlines from blocks
lstripBlocksbooleanNoStrip leading whitespace from blocks
outputEncodingstringNoFile encoding (default: utf8)

Directory Mode Options

OptionTypeRequiredDescription
inputDirstringYesSource directory containing templates
outputDirstringYesOutput directory for rendered files
patternstringNoGlob pattern (default: **/*.html.jinja)
excludePatternsstring[]NoPatterns to exclude (e.g., partials)
stripExtensionstringNoExtension to remove (default: .jinja)
contextobjectNoShared context for all templates
contextFilesstring[]NoYAML/JSON files to merge
searchPathsstring[]NoTemplate search paths for includes
autoescapebooleanNoEnable HTML escaping
trimBlocksbooleanNoTrim trailing newlines from blocks
lstripBlocksbooleanNoStrip leading whitespace from blocks
outputEncodingstringNoFile encoding (default: utf8)

Development

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

Requirements

  • Node.js >= 22.0.0
  • npm >= 10.0.0

License

MIT

版本与发布记录

@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 template rendering actions for kist with single-file and directory mode support

如何安装 @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 和提交记录判断。