npm 包 minami_customized 使用教程

AI 编程助手，豆包旗下的编程助手，提供智能补全、智能预测、智能问答等能力，节省开发时间，释放脑海中的创造力，支持 VSCode，点击体验 AI

前言

npm 是一个常用的 JavaScript 包管理器，其中包含了各种工具、框架、模块等，提供了大量的前端资源。mimani_customized 是一个 npm 包，是针对开源项目 jsdoc3 的一个自定义主题，为 jsdoc3 文档生成工具提供了一个定制化的主题样式，可以更好地呈现 jsdoc3 生成的文档内容。

安装

首先，需要在本地或者项目中安装 jsdoc 和 minami_customized，安装命令如下：

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

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

使用

安装完成之后，就可以使用 minami_customized 来生成自定义的 jsdoc3 文档了，具体步骤如下：

  1. 在项目中添加 jsdoc 配置文件 jsdoc.conf.json，文件内容如下：
-
  ------- -
    ------------------- -----
    --------------- ---------
  --
  --------- -
    ---------- -
      ------
      -----------
    --
    ---------- -
      --------------
    --
    ----------------- -----------------
    ----------------- ---------------
  --
  ------- -
    ----------- --------------------
    -------------- --------
    ----------- -------
    ---------- -----
    ---------- -----
    --------- --------------
    --------- ------
    ---------- ----------------
  -
-
  1. 执行以下命令，生成文档：
- ----- -- ---------------

待生成完成后，打开 docs/index.html 即可浏览生成的自定义文档了。

示例代码

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

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

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

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

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

结语

minami_customized npm 包提供了一个定制化的 jsdoc3 主题样式，可以更好地展现文档内容。本篇文章介绍了该包的安装和使用方法，并提供了示例代码，希望能对前端开发者有所帮助。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066f481d8e776d08041150

阅读全文

猜你喜欢

  • npm 包 objit 使用教程

    在前端开发中，有时候我们需要对 JavaScript 对象进行特定的操作，比如添加、删除、修改属性等等。而 npm 包 objit 就能够帮助我们更方便地实现这些操作。

    4 年前
  • npm 包 ohmu 使用教程

    ohmu 是一个用于生成对象嵌套关系可视化图的 JavaScript 库。如果你需要在前端项目中可视化对象关系，ohmu 是一款非常不错的工具。 安装 ohmu 是 npm 包，你可以在终端中输入如下...

    4 年前
  • occurrence

    Handle browser events. Occurrence Handle browser events. Under development This package will be ava...

    4 年前
  • npm 包 ocdlint 使用教程

    在前端开发过程中，我们需要不断保持代码的规范性和可读性，以便更好地维护和共享代码。而 ocdlint 就是一个非常实用的 npm 包，可以帮助我们自动化检测代码的规范性，确保代码的可读性和可维护性。

    4 年前
  • npm 包 objectus 的使用教程

    在前端开发中，对象是不可避免的。而 Objectus 是一个非常实用的 npm 包，它提供了许多方便的方法来处理 JavaScript 对象。在本篇文章中，我们将详细介绍 objectus 的使用方法...

    4 年前
  • npm 包 objektiv 使用教程

    前言 在前端开发中，我们需要频繁地操作对象，例如获取对象的某个属性或者设置对象的某个属性值，这些操作在项目中是必不可少的。然而，在实际开发中往往会碰到一些问题，尤其是嵌套对象的处理，给开发带来了不少难...

    4 年前
  • npm 包 objextender 使用教程

    在前端开发中，经常需要对对象进行操作，例如给对象的属性赋值、添加属性、删除属性等。而 objextender 是一个可以帮助我们快速进行对象操作的 npm 包。 安装 使用 npm 进行安装： ---...

    4 年前
  • npm包oibackoff使用教程

    oibackoff是在JavaScript中实现的一个用于执行有条件的退避和重试的库。它可以在遇到错误或不合适的条件时，反复尝试代码块，以便达到预期结果。 该库可以在Web应用程序、Node.js应用...

    4 年前
  • npm 包 oddcast-msgpack 使用教程

    介绍 在前端开发中，有时候需要在不同的设备和平台之间传输数据。而传统的 JSON 格式在数据量大的情况下性能和带宽的消耗比较大，特别是在低带宽或高延迟的网络环境中，效率低。

    4 年前
  • Npm 包 oddcast-tcp-transport 使用教程

    介绍 oddcast-tcp-transport 是一个 Node.js 应用程序，用于在本地主机和远程计算机之间建立 TCP 连接。这个 npm 包非常适合于前端类应用程序的开发，因为它可以帮助前端...

    4 年前
  • npm 包 oddiff 使用教程

    介绍 oddiff 是一个 JavaScript 库，可用于比较两个对象之间的差异并返回新对象。该库使用对象扁平化算法来生成对象差异，并且可以与 React、Angular、jQuery 等其他库或框...

    4 年前
  • npm 包 ohmygraph 使用教程

    前言 随着前端技术的发展，我们逐渐离不开 npm 包，而 npm 不仅为我们项目提供了良好的管理和协作方式，也为我们提供了各种常用的库或插件，ohmygraph 就是其中一个优秀的 npm 库。

    4 年前
  • npm 包 ohnogit 使用教程

    1. 简介 ohnogit 是一个 npm 包，为开发者提供了一个简单而强大的工具来避免不小心将敏感信息提交到 git 仓库中。在开发时，我们经常需要在代码中使用敏感信息，如 API key、密码等等...

    4 年前
  • npm 包 ohu-detect 使用教程

    简介 ohu-detect 是一款基于 ua-parser-js 的前端浏览器检测工具，可用于判断浏览器厂商、浏览器版本等信息。它提供了一种方便快捷的方式来检测 Web 应用程序中的客户端特性，可以帮...

    4 年前
  • npm 包 ohsojuicy 使用教程

    前言 在前端开发中，使用 npm 包来加速自己的开发是必不可少的一步。而在众多的 npm 包中，ohsojuicy 是一款非常优秀的 npm 包之一。这个包的主要作用是生成漂亮的渐变色。

    4 年前
  • npm 包 ohu-share 使用教程

    npm 包 ohu-share 使用教程 介绍 ohu-share 是一个能够帮助前端开发者快速实现分享功能的 npm 包。无需编写繁琐的分享代码，只需要引入 ohu-share 包，即可轻松实现分享...

    4 年前
  • npm 包 oib.js 使用教程

    简介 oib.js 是一个用于生成身份证号码的 JavaScript 库。它可以用于前端以及后端的开发。 npm 包名: oib.js 作者: John Doe 版本: 1.0.0 安装 使用 n...

    4 年前
  • npm 包 oddity 使用教程

    简介 oddity 是一个基于 Node.js 平台的开源轻量级前端自动化构建工具，它可以用来编译、打包和压缩前端代码，并支持自动刷新、ES6 转换和 CSS 预处理等功能。

    4 年前
  • npm 包 oddlog 使用教程

    在前端开发中，打印日志是非常常见的操作。然而，传统的 console.log() 方法往往无法满足我们的需求，因为它并不支持高级特性，如：输出级别、输出样式、输出到文件等等。

    4 年前
  • npm 包 oddlog-cli 使用教程

    在前端开发中，日志是非常重要的一部分，它可以帮助开发者更好地了解程序的运行状况，及时发现问题并给出解决方案。而 oddlog-cli 是一款 npm 包，可以帮助我们更好地管理日志，使我们的开发更加高...

    4 年前

相关推荐

    暂无文章