npm 包 @freshes/humans 使用教程

在今天的网页设计中,设计师不仅需要考虑用户界面的美观性,还要关注用户体验和信息架构。为了帮助前端开发者更好地处理这些问题,@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


猜你喜欢

  • npm 包 cordova-plugin-testsvn 使用教程

    介绍 cordova-plugin-testsvn 是一个基于 Apache Cordova 的插件,用于管理在 Subversion(SVN)仓库中的代码,并在应用中引用 SVN 中的文件。

    3 年前
  • npm 包 js-local-cache 使用教程

    前言 在前端开发中,我们经常会遇到需要对一些数据进行缓存的场景。这时候,我们可以选择使用浏览器自带的 LocalStorage 或者 SessionStorage 进行缓存,但是它们的容量有限,且只能...

    3 年前
  • NPM 包 extract-json-from-string 使用教程

    在前端开发中,我们经常需要从字符串中提取 JSON 数据,因此我们需要一种简单方便的方法来完成这个操作。 npm 包 extract-json-from-string 就提供了这样的解决方案。

    3 年前
  • npm 包 veams-component-article 使用教程

    简介 veams-component-article 是一个基于 Veams(一个前端开发框架)的组件,用于快速创建文章页面和文章列表页面。 安装 在安装之前,请确保你已经安装了 Veams 和 No...

    3 年前
  • npm 包 veams-component-comparer 使用教程

    如果你是一名前端开发人员,那么你一定会遇到这样的情况:在开发一个大型项目时,你需要处理大量的组件。这些组件往往有相似之处,但也存在一些微小的差别。在这种情况下,如何比较这些组件的差异,进而更有效地管理...

    3 年前
  • npm 包 veams-component-accordion 使用教程

    在前端开发中,使用现成的开源组件可以快速实现界面效果,提高开发效率和代码质量。veams-component-accordion 是一个开源的前端组件,用于创建可折叠的内容块。

    3 年前
  • npm 包 veams-component-cta 使用教程

    什么是 veams-component-cta veams-component-cta 是一款让前端开发人员能够快速实现各种呼叫动作(Call To Action)的组件库。

    3 年前
  • npm 包 veams-component-pagination 使用教程

    在前端开发中,分页功能非常常见,而实现分页功能的方式有很多,其中一种方式就是使用 veams-component-pagination 这个 npm 包。该包提供了强大的分页功能,可用于在网站或应用程...

    3 年前
  • npm包veams-component-slide-fox使用教程

    在现代Web开发中,前端组件化已经是必须的。随着前端框架和技术的不断发展,组件化的框架和工具也变得越来越丰富。而veams-component-slide-fox是一款在Veams Framework...

    3 年前
  • npm 包 pm2-restart-notifier 使用教程

    前言 在前端开发中,pm2 是一个非常常用的进程管理工具,可以用来启动、停止、重载应用程序等等,方便快捷。但是,在一些场景下,我们需要知道 pm2 重启了哪些进程,以便更好的监控和管理项目。

    3 年前
  • npm 包 vue-patternfly-ts 使用教程

    前言 在前端开发中,找到一个合适且易用的组件库是非常重要的。而 vue-patternfly-ts 正是一个基于 Vue.js 的组件库,集成了 PatternFly 的样式并且使用 TypeScri...

    3 年前
  • npm 包 sls-git-modules 使用教程

    在使用 Serverless 框架部署项目时,常常需要引用一些外部资源,比如第三方库或自定义插件。而这些资源可能会不定期地更新,这就需要我们进行手动管理,并且更新版本号等信息。

    3 年前
  • npm 包 swagger-ui-express-lightweight 使用教程

    在前端领域中,有许多优秀的 npm 包可以帮助我们更好地开发和设计项目。其中, swagger-ui-express-lightweight 就是一款非常好用的 npm 包。

    3 年前
  • npm 包 polarity-rate 使用教程

    前言 在大量的文件数据中,我们常常需要对其进行情感分析,用以了解该数据的情感倾向。NPM 生态中有许多开源的 JS 工具包可以帮助我们分析文本的情感倾向,其中 polarity-rate 就是一个不错...

    3 年前
  • npm 包 easy-backblaze 使用教程

    在前端开发中,数据的存储和备份是非常重要的一个环节。为了方便开发者快速接入云存储服务,很多厂商都提供了相应的 API 接口和 SDK,让开发者可以更快捷地实现云存储服务的集成。

    3 年前
  • npm包ecstatic-htpasswd使用教程

    在前端开发中,我们经常需要通过HTTP服务器来提供静态资源。今天我们要介绍的是一个npm包叫做ecstatic-htpasswd,它是一个HTTP服务器,可以通过使用htpasswd文件进行用户验证。

    3 年前
  • npm 包 gatsby-plugin-gosquared 使用教程

    随着互联网的快速发展,网站数据分析的需求越来越多,GoSquared 是一个很好的数据分析工具。本篇文章将带大家详细介绍如何使用 npm 包 gatsby-plugin-gosquared 来集成 G...

    3 年前
  • npm 包 @b-stud/bezier-canvas 使用教程

    npm 包 @b-stud/bezier-canvas 使用教程 前言 随着 Web 技术的不断发展,前端技术越来越成熟,除了基础的 HTML、CSS、JavaScript 之外,还存在着诸多优秀的 ...

    3 年前
  • npm 包 react-setup-generator 使用教程

    简介 React 是目前最流行的前端框架之一,但是在每次开始一个新的 React 项目时,都需要进行繁琐的配置。在这个过程中,react-setup-generator 就成为了一种非常有用的工具。

    3 年前
  • npm 包 aid-layout 使用教程

    在日常的前端开发中,我们经常需要使用布局相关的工具来处理网页的排版问题。而 aid-layout 正是一款优秀的 npm 包,它提供了一系列帮助我们实现网页布局的方法和组件,极大地提高了我们的开发效率...

    3 年前

相关推荐

    暂无文章