@bigcommerce/stencil-paper

中文文档
5.4.5发布于 2026/08/18BSD-4-ClauseCommonJS构建来源已验证近 30 天下载 1万

一个Stencil插件来加载模板文件并使用后端渲染器插件渲染页面.

中文使用文档

速记纸

Build Status npm (scoped)

速记纸 是用于 stencil-cli它的职责是装入模板和翻译,并呼叫 输出到 纸条 翻译页面.

使用量

将纸张装入您的应用程序 :

const Paper = require('@bigcommerce/stencil-paper');

静态纸通过 siteSettings, (中文(简体) ), themeSettings, (中文(简体) ), assembler,可选 logger (覆盖默认日志):

const paper = new Paper(siteSettings, themeSettings, assembler, logger);

这个 assembler 是“纸”用于装入模板和翻译的界面。 这样我们可以用纸张装入模板 从文件系统或任何其他来源。 这只是一个执行两种方法的对象: getTemplates() 打开 getTranslations()数字 :

const assembler = {
    getTemplates: (path, processor) => {
        return new Promise((resolve, reject) => {
            // implement me
            resolve(processor(templates));
        });
    },
    getTranslations: () => {
        return new Promise((resolve, reject) => {
            // implement me
            resolve(translations);
        });
    }
};

现在我们可以装入我们想要渲染的一页的主题:

paper.loadTheme(path, 'en').then(() => {
    paper.render(path, context).then(html => {
        reply(html);
    });
});

帮助参考

见 stencil API 参考文献 用于提供可用帮助的文档.

许可证

版权 (c)2015-2022 大通商股份有限公司. 版权所有.

源形式和二进制形式的再分配和使用,不论有无 修改,但必须符合下列条件:

  1. 源代码的再分配必须保留上述版权 通知、本条件清单和下列免责声明.
  2. 二进制形式的再分配必须复制上述版权 通知、本条件清单和 分发时提供的文件和/或其他材料.
  3. 所有提及该软件特征或使用的广告材料 必须显示下列确认: 该产品包括由Bigcommerce Inc所开发的软件.
  4. Bigcommerce Inc.)的名称或名称 或 其贡献者姓名可用于认可或推广产品 来源于此软件,无须事先具体书面许可.

这个软件是大公司提供的 "AS IS"和任何 战争遗留爆炸物,包括但不受限制的 对某一特别目的而言 分会。 绝对不能为任何人 提供大奖赛 直接、间接、突发事件、特别、紧急、或后果 (包括,但不限制,实质性货物或服务的采购; 使用、数据或赞助;或业务中断) 关于任何负债的理论,无论在合同、合同或合同中 以任何方式出现于此用途之外 苏发,即使咨询 的可能性 这样的灾难.

版本与发布记录

@bigcommerce/stencil-paper 共发布 181 个版本,首次发布于 2016/03/08;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.4.5latest2026/08/182 个月前
5.4.42026/07/293 个月前
5.4.32026/07/143 个月前
5.4.22026/06/114 个月前
5.4.12026/03/317 个月前
5.4.02025/12/1910 个月前

关于 @bigcommerce/stencil-paper 的常见问题

@bigcommerce/stencil-paper 是什么?

一个Stencil插件来加载模板文件并使用后端渲染器插件渲染页面.

如何安装 @bigcommerce/stencil-paper?

在项目目录运行 npm install @bigcommerce/stencil-paper,或使用 pnpm add / yarn add / bun add。

@bigcommerce/stencil-paper 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/bigcommerce__stencil-paper 是否存在。

@bigcommerce/stencil-paper 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@bigcommerce/stencil-paper 可以商用吗?

@bigcommerce/stencil-paper 使用 BSD-4-Clause 许可。声明的许可为 BSD-4-Clause,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@bigcommerce/stencil-paper 的下载量有多少?

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

@bigcommerce/stencil-paper 还在维护吗?

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