跳到正文

函数

函数让你通过自定义工具扩展 Markdoc，这些工具可以在运行时转换你的内容和变量。

内置函数

Markdoc 开箱即用，包含六个内置函数：equals、and、or、not、default 和 debug。

函数返回值示例描述
equalsbooleanequals($myString, 'test')执行常见的布尔操作
andbooleanand($boolean1, $boolean2)执行常见的布尔操作
orbooleanor($boolean1, $boolean2)执行常见的布尔操作
notbooleannot(or($boolean1, $boolean2))执行常见的布尔操作
defaultmixeddefault($variable, true)如果第一个参数是 undefined，则返回第二个参数
debugstringdebug($anyVariable)将值序列化为 JSON 格式以供调试

与/或/非

将这些函数与 if 标签 结合使用，以执行布尔操作并在条件满足时渲染内容。

Warning

与 JavaScript 不同，Markdoc 只将 undefined、null 和 false 视为假值。

这段内容始终显示
{% if and(not($a), or($b, $c)) %}
仅当 $a 为假值且 $b 或 $c 为真时显示此内容。
{% /if %}

等于

使用 equals 函数将变量与给定值进行比较。此函数使用 JavaScript 的严格相等语义，仅用于原始类型。

{% if equals($myVar, "test") %}
变量 $myVar 等于字符串 "test"。
{% /if %}

默认值

此函数用于为可能不存在的变量设置值。

{% if default($showPrompt, true) %}
嘿，你好！
{% /if %}

调试

此函数将值作为序列化的 JSON 值渲染到文档中。这有助于确定变量中的值。

{% debug($myVar) %}

创建自定义函数

要使用你自己的函数扩展 Markdoc，首先创建自定义函数定义：

const includes = {
  transform(parameters) {
    const [array, value] = Object.values(parameters);

    return Array.isArray(array) ? array.includes(value) : false;
  }
};

const uppercase = {
  transform(parameters) {
    const string = parameters[0];

    return typeof string === 'string' ? string.toUpperCase() : string;
  }
};

然后，将函数传递给您的config对象。

/** @type {import('@markdoc/markdoc').Config} */
const config = {
  functions: {
    includes,
    uppercase
  }
};

const content = Markdoc.transform(ast, config);

最后，在您的 Markdoc 内容中调用这些函数

{% if includes($countries, "AR") %} 🇦🇷 {% /if %}
{% if includes($countries, "AU") %} 🇦🇺 {% /if %}
{% if includes($countries, "ES") %} 🇪🇸 {% /if %}
{% if includes($countries, "JP") %} 🇯🇵 {% /if %}
{% if includes($countries, "NG") %} 🇳🇬 {% /if %}
{% if includes($countries, "US") %} 🇺🇸 {% /if %}

后续步骤