拓十年匠心定制 · 商业建站与技术教学双线并行 咨询热线:400-886-1026 service@lmnt.cn
ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

readme生成器

readme生成器 生成器这是一个npm命令行工具,这个工具的作用是用来生成文件的。安装npm install --global yo generator-standard-readme使用命令行输入$ yo standard-readme在后面会有许多问题被提出来, 而后生成一个文件。所有的相关问题列举如下所示:What do you want to name your module?What is the description of this module?Do have a banner image?Where is the banner image?Ex: img/banner.pngDo you want a TODO dropped where your badges should be?Do you want a TODO dropped where your long description should be?Do you need a prioritized security section?Do you need a background section?Do you need an API section?What is the GitHub handle of the main maintainer?Do you have a CONTRIBUTING.md file?Are PRs accepted?Is an MIT license OK?What is your license?Who is the License holder (probably your name)?Use the current year?What years would you like to specify?示例$ yo standard-readme? Were constantly looking for ways to make yo better!May we anonymously report usage statistics to improve the tool over time?More info: http://yeoman.io Yes?What is the name of your module? zj? What is the description of this module? yo使用示例? Do have a banner image? No?Do you want a standard-readme compliant badge? Yes? Do you want a TODO dropped where more badges should be? Yes?Do you want a TODO dropped where your long description should be? Yes? Do you need a prioritized security section? No?Do you need a background section? Yes? Do you need an API section? No? What is the GitHub handle of the main maintainer? zjZSTU?Do you have a CONTRIBUTING.md file? No? Are PRs accepted? Yes? Is an MIT license OK? Yes? Who is the License holder (probably your name)? zjZSTU?Use the current year? Yescreate README.md文件生成之后, 得到的内容具体如下所示:# zj // 标题[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?styleflat-square)](https://github.com/RichardLitt/standard-readme) // 徽章TODO: Put more badges here. // 可以添加更多徽章 yo使用示例 // 简短说明TODO: Fill out this long description. // 详细说明## Table of Contents // 下面的章节列表每个章节都可以点击跳转- [Background](#background)- [Install](#install)- [Usage](#usage)- [Maintainers](#maintainers)- [Contributing](#contributing)- [License](#license)## Background // 背景## Install // 安装## Usage // 用法## Maintainers // 主要维护人员[zjZSTU](https://github.com/zjZSTU)## Contributing // 参与贡献方式PRs accepted.Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.## License // 许可证MIT © 2019 zjZSTU
返回列表