npm 包 @freshes/humans 使用教程

阅读时长 5 分钟读完

在今天的网页设计中,设计师不仅需要考虑用户界面的美观性,还要关注用户体验和信息架构。为了帮助前端开发者更好地处理这些问题,@freshes/humans 库应运而生。本文将详细介绍该库的使用方法。

什么是 @freshes/humans

@freshes/humans 是一个用于 Web 网站的 humans.txt 文件生成器,它通过规范化的注释格式生成 humans.txt 文件。这个文件可以包含有关您网站中的人员、工具和技术的简要信息,以便其他开发人员、设计师和用户了解您网站背后的故事。

安装

使用该库需要先在项目中安装它。可以使用命令行来引用它并安装:

使用

一旦你在你的项目中安装了 @freshes/humans,你就可以在你的项目中使用它来创建 self-documented humans.txt 文件。首先,您需要在您的项目目录中创建 humans.js 文件(名称完全相同是可选的)。接下来,按照以下代码格式输入所需的信息:

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

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

这里是代码的重点。在 team 对象中,您可以列出您想要列出的任何人员信息,例如原始开发者、设计师或贡献者。同样,您可以在 thanks 对象中列出您想要感谢的任何开源软件或框架。在 errors 对象中,您可以添加自定义错误页面。最后,在 note 字段中,您可以添加任何备注或消息信息。

最后,运行以下命令即可自动生成 humans.txt 文件:

这将生成一个名为 humans.txt 的文件,其中包含以上定义的人员信息,感谢信息、错误页面和备注信息。

总结

通过使用 @freshes/humans 库,您可以更轻松地管理自己的站点信息。请试试并享受它带来的便利。

参考代码:

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

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

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

纠错
反馈