npm 包 @11ty/eleventy-plugin-inclusive-language 使用教程

阅读时长 4 分钟读完

随着互联网的快速发展,我们越来越意识到一个包容的环境对于所有人的受众、用户体验、沟通等意义的重要性。@11ty/eleventy-plugin-inclusive-language 是一个非常有用的 npm 包,它可以帮助开发人员在网站或应用程序中使用包容性语言。

什么是 @11ty/eleventy-plugin-inclusive-language?

@11ty/eleventy-plugin-inclusive-language 是一个 Eleventy 插件,它可以分析网站或应用程序中的文本,并生成关于包容性语言实践的报告,包括检测到的问题和建议的解决方案。

该插件的功能包括:

  • 检查敏感语言和现代化用语。
  • 检测具有贬损含义的术语。
  • 检测不足或标记过度的文本。
  • 提供包容性替代方案,以更好地涵盖受众。

如何使用 @11ty/eleventy-plugin-inclusive-language?

要使用@11ty/eleventy-plugin-inclusive-language,您需要将其安装为插件。首先,请确保您的计算机上已安装 npm。接下来,在您的项目文件夹中,运行以下命令安装插件:

此命令将下载和安装 @11ty/eleventy-plugin-inclusive-language ,并将其添加到您的项目的 package.json 文件中。

现在,您已经安装了@11ty/eleventy-plugin-inclusive-language,接下来,您需要在Eleventy配置文件中添加该插件。在您的 .eleventy.js 文件中,将@11ty/eleventy-plugin-inclusive-language 添加到您的配置选项中,并设置选项,如下所示:

-- -------------------- ---- -------
----- ----------------------- - ----------------------------------------------------

------------------------------------------------- -
  -------------------- ------ ----- ------
  ------- ---------
  ---------- -
    -- -
      ------- ---- ----- ----------- --- ----------- --------- ----------- ----- ----- -------
      -------- ---------------------
      ----- -----
    --
    -- -
      ------- ---- ---- -------- --- --------- -- ----------
      -------- --------------------
      ----- ----
    -
  -
---
展开代码

您可以自定义配置以满足您的需要。配置选项包括:

  • ignoredLanguageTags: 忽略哪些语言标签的检测。
  • ignore:忽略哪些单词不做处理。
  • reminders: 您可以设置需要提醒的词汇,它会在输出中提醒您。

接下来,在生成您的网站时,@11ty/eleventy-plugin-inclusive-language 将分析您的文本并生成报告文件,您可以查看报告文件以了解有关您的网站使用的包容性语言的更多信息。

示例代码

以下是一个示例 Eleventy 模板,其中使用了 @11ty/eleventy-plugin-inclusive-language:

-- -------------------- ---- -------
---
------- --------
------ -- --------- ----
---
------
  ------ ----- -------
  ------ ----- ----- --- ----- ---- --- ---- ---- ----- ----- ----- --- ---- ----------- ----------- ----- ------------ ---------- ------ ---- ------ ---- -------- ---- ----- ------------
-------

-- ------------------------- ---------- --
展开代码

在这个例子中,我们使用 @11ty/eleventy-plugin-inclusive-language 分析了我们的文本,来生成报告。

结论

@11ty/eleventy-plugin-inclusive-language 是一个非常有用的 npm 包,它可以帮助开发人员为他们的网站或应用程序创建更包容性的环境。使用此插件可以让我们更好地涵盖我们的受众,并避免使用很容易被忽视的不包容性语言或表达方式。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedd5f4bb4e78292a6fb850

纠错
反馈

纠错反馈