--- title: 使用宏 slug: MDN/Structures/Macros tags: - Guide - Kuma - KumaScript - MDN Meta - Structures translation_of: MDN/Structures/Macros ---
为了自动化执行某些工作,Yari 平台提供了一个强大的宏系统——KumaScript。本文提供了一些相关信息,方便你在参与编辑 MDN 时,使用这些宏。
本文只是简要介绍了 KumaScript,KumaScript 指南提供了更深入的内容,帮助你使用和掌握它。
MDN 使用宏是基于运行于服务器上的 JavaScript 代码实现的,并由 Node.js 解释执行。在此之上,已经实现了一个丰富的工具库,让宏可以与这个平台及其中的内容进行互动。
要实际使用宏,只需将对宏的调用和可能需要的参数写在一对双括号中,如下:
\{{macroname(parameter-list)}}
关于宏调用的一些注意事项:
\{{macroname()}}
和 \{{macroname}}
的效果是。宏的几乎所有执行结果都会被缓存,以便被重用来加快执行速度。这意味着宏仅在输入发生变化时才实际运行,包括调用时的参数以及环境值(例如这个宏被调用时所在的路径)。
宏既可以用来做一些简单的工作,比如插入更大的文本块或从MDN的另一部分交换内容一样简单,也可以通过搜索站点的各个部分,设置输出样式和添加链接来构建整个内容索引。
您可以在常用的宏页面看到一些我们最常用到的宏,还可以在我们 Github 的仓库中,浏览所有可用的宏。大多数宏顶部的注释中,都有内置的文档帮助你了解它的作用。