npm 包 embellish-readme 使用教程

在开发一个 npm 包时,写好的代码并不是唯一重要的,一个清晰易懂的 README 文件同样也很重要。而 embellish-readme 这个 npm 包可以帮助我们让 README 文件更加优美。

安装

使用 npm 安装该包:

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

用法

  1. 首先,在你的项目根目录下创建一个 .emreadme 文件夹,并在其中创建一个 template.md 文件。
  2. template.md 文件中编写 README 的模板内容。支持 EJS 模板语言,所以你可以使用 EJS 语法来动态生成内容。
  3. 运行 emreadme init 命令,该命令将会根据模板文件创建出 README.md 文件,并将其置于你的项目根目录下。

示例

以下是一个示例项目结构:

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

然后在 .emreadme/template.md 中,我们可以这样定义 README 内容:

- --- ---- --

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

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

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

npm install --save <%= name %>

-- -----

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

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

License

MIT

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

-- --

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

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

猜你喜欢

  • 前端项目共有的CSS问题

    在前端开发中,CSS 是不可或缺的一部分。然而,由于每个开发者的技术背景和经验都不同,会存在一些共有的 CSS 问题,这些问题可能导致网站性能下降、UI 不一致、代码难以维护等问题。

    6 年前
  • npm 包 metro-minify-uglify 使用教程

    简介 在前端开发中,我们经常需要将 JavaScript 代码进行压缩,使其体积更小、加载速度更快。而 metro-minify-uglify 就是一个可以帮助我们实现这一功能的 npm 包。

    6 年前
  • npm 包 metro-config 使用教程

    什么是 metro-config? metro-config 是一个用于配置 Metro 打包工具的 npm 包。它提供了一种简单的方式来配置 Metro 工具链的行为,例如指定入口文件、设置别名、添...

    6 年前
  • npm 包 metro-cache 使用教程

    什么是 metro-cache? metro-cache 是一个用于 Metro 打包器的缓存插件,可以在重新打包前将上一次的结果进行缓存并进行复用,以提高打包速度。

    6 年前
  • npm 包 metro-babel-transformer 使用教程

    介绍 metro-babel-transformer 是一个用于 JavaScript 代码转换的 npm 包,它可以通过 babel 转换器对代码进行处理。使用 metro-babel-transf...

    6 年前
  • npm 包 nullthrows 使用教程

    在 JavaScript 开发中,经常会遇到变量值为 null 或 undefined 的情况,如果不进行判断和处理,可能会导致程序崩溃或出现错误。nullthrows 是一个可以帮助我们更好地处理这...

    6 年前
  • npm 包 metro-source-map 使用教程

    简介 metro-source-map 是一个 JavaScript 库,用于在 Metro bundler 中生成 source map。它可以帮助开发者方便地调试和排查代码的问题。

    6 年前
  • npm包 metro-react-native-babel-preset 使用教程

    在 React Native 开发中,Babel 是必不可少的工具,它可以将 ES6+ 代码转换成兼容性更好的代码。而 metro-react-native-babel-preset 则是一个专门为 ...

    6 年前
  • npm 包 metro-react-native-babel-transformer 使用教程

    简介 metro-react-native-babel-transformer 是一个基于 Babel 的转换器,它可以将 React Native 项目中使用的 ES6/7/8 语法和 JSX 语法...

    6 年前
  • npm 包 xpipe 使用教程

    xpipe 是一个 Node.js 模块,可以用于在前端中实现类似于 Linux 系统中的管道(pipe)功能。使用 xpipe 可以轻松地将多个数据处理函数组合起来,从而形成数据处理流水线,并最终生...

    6 年前
  • npm 包 cytoscape-euler 使用教程

    cytoscape-euler 是一个基于 cytoscape.js 的布局扩展包,它使用欧拉图算法来自动排列和布局图形。在本篇文章中,我们将讨论如何使用 cytoscape-euler 将图形可视化...

    6 年前
  • npm包cytoscape-dagre使用教程

    简介 cytoscape-dagre是一个基于cytoscape.js的布局扩展,它使用dagre库来进行有向无环图(DAG)的布局。在前端开发中,如果需要用到DAG图,使用cytoscape-dag...

    6 年前
  • npm 包 babel-preset-umi 使用教程

    什么是 babel-preset-umi? babel-preset-umi 是一个 npm 包,它是 UmiJS 框架的预设 Babel 插件。这个插件可以帮助你在 UmiJS 应用中使用最新的 J...

    6 年前
  • npm包umi-test使用教程

    在前端开发中,测试是非常重要的环节。而npm包 umi-test 是一款基于 Jest 的测试框架,为 React + Umi 集成测试提供了便利。 安装 使用 npm 或者 yarn 进行安装,建议...

    6 年前
  • npm 包 slash2 使用教程

    在前端开发中,我们经常需要处理文件路径。而使用正斜线(/)和反斜线(\)的差异可能会导致跨平台的问题。为了避免这种问题,我们可以使用 npm 包 slash2 来规范化文件路径。

    6 年前
  • npm 包 umi-tools 使用教程

    简介 umi-tools 是一个用于构建 React 应用的开发工具配置库,它基于 UmiJS 构建,并提供了一系列工具和插件,帮助你快速搭建和开发 React 应用。

    6 年前
  • npm 包 react-style-proptype 使用教程

    在 React 中,组件的样式通常使用 style 对象来定义。然而,在开发中,我们经常会遇到需要验证样式对象是否符合预期的情况。为了解决这个问题,我们可以使用 react-style-proptyp...

    6 年前
  • npm 包 react-css-themr 使用教程

    背景介绍 React 是一种用于构建用户界面的 JavaScript 库。随着 React 的流行,越来越多的开发者开始使用 React 来构建应用程序。在 React 中,CSS 样式是很重要的一部...

    6 年前
  • npm 包 postcss-each 使用教程

    介绍 postcss-each 是一个 PostCSS 插件,可以让你使用类似于 @each 的语法来生成 CSS 规则。 在传统的 CSS 中,我们需要写多个相似的规则,这些规则只是其中某些值有所不...

    6 年前
  • npm 包 postcss-mixins 使用教程

    前言 在前端开发中,我们经常会使用 CSS 预处理器(如 Sass 或 Less)来提高代码可维护性和开发效率。而 postcss-mixins 是一个用于 PostCSS 的 mixin 插件,它提...

    6 年前

相关推荐

    暂无文章