@abhisekp/test-npm-app 中文文档教程
:crown: test-npm-app :crown:
:crown: test-npm-app:crown:
这是一个非常短的单行包描述，与包中的描述相匹配.json 文件和 github short repo description with not more than 120 characters
- Must be less than 120 characters.
- Must start with >
- Must be on it's own line.
- Must match the description in the packager manager's description field.
- Must match GitHub's description (if on GitHub).
(optional) 一个非常长的包描述，带有一个不太长的句子。 它可能会扩展到 2-3 段
涵盖构建存储库的主要原因
“这应该从广义上描述您的模块，通常只用几段；模块例程或方法的更多细节、冗长的代码示例或其他 -深度材料应该在后续章节中提供。
理想情况下，稍微熟悉您的模块的人应该能够刷新他们的记忆而无需点击“向下翻页”。随着您的读者继续阅读文档，他们应该逐渐获得更多的知识。 “
:checkered_flag: Table of Contents
必须至少有 3 级深度，即至少捕获标题 1、2 和 3。
:cop: Security ⮭
（可选）添加任何安全漏洞相关数据（如果适用
:briefcase: Background ⮭
- Cover motivation if not already specified in "Long Description".
- Cover abstract dependencies.
- Cover intellectual provenance: A See also section is also fitting.
:cloud: Installation ⮭
$ npm install --global test-npm-app-cli # npm i -g test-npm-app-cli
$ npm install --save test-npm-app # npm i -S test-npm-app
:link: Dependencies ⮭
）（可选）重要依赖包的简要说明
:satellite: Updating ⮭
（可选）如何更新和更新说明
- Link to prerequisite sites for language. [npmjs][], [godocs][], etc.
- Include any system-specific information needed for Installation.
- Subsection for dependencies needed for install to work.
:rocket: Usage ⮭
import testNpmApp from 'test-npm-app'
// OR
var testNpmApp = require('test-npm-app');
:computer: CLI ⮭
$ test-npm-app --options --flags --help
:nutandbolt: Extras ⮭
- Include background info if not specified in background section
- Include security related info if not specified in security section
:loop: API ⮭
描述导出的函数和对象.
- Describe signatures, return types, callbacks, and events.
- Cover types covered where not obvious.
- Describe caveats.
- If using an external API generator (like go-doc, js-doc, or so on), point to an external API.md file. This can be the only item in the section, if present.
:speedboat: Examples ⮭
示例列表
:bustsinsilhouette: Contribute ⮭
- State where users can ask questions.
- State whether PRs are accepted.
- List any requirements for contributing; for instance, having a sign-off on commits.
- Link to CONTRIBUTE.md file -- if there is one.
- Link to the GitHub issues.
- :bowtie: Link to Code of Conduct. This is often in Contribute, or organization wide, so may not be necessary for each module.
:hospital: Help & Support ⮭
添加链接以获取有关此项目的帮助和支持。
:family: Contributors ⮭
该项目遵循 all-contributors 规范。
:trophy: Sponsors ⮭
赞助商名单赞助
Patreon等媒体
:memo: License ⮭
:two_hearts: Related Projects ⮭
相关项目列表
:ghost: Author ⮭
推文 
@abhisek
了解about/abhisekp
与 聊天 
@abhisekp
[abhisekpAboutLink]: https://about.me/abhisekp
<!-- BANNER-MD:START (optional) - Do not remove or modify this section
:crown: test-npm-app :crown:
<!-- TITLE-MD:START - Do not remove or modify this section
:crown: test-npm-app:crown:
<!-- BADGE-LIST:START - Do not remove or modify this section
this is a very short single line description of the package matching the description in the package.json file and github short repo description with not more than 120 characters
- Must be less than 120 characters.
- Must start with >
- Must be on it's own line.
- Must match the description in the packager manager's description field.
- Must match GitHub's description (if on GitHub).
(optional) A very long description of the package with a not so long sentence. It may extend to 2-3 paragraphs
Covers the main reasons for building the repository
"This should describe your module in broad terms, generally in just a few paragraphs; more detail of the module's routines or methods, lengthy code examples, or other in-depth material should be given in subsequent sections.
Ideally, someone who's slightly familiar with your module should be able to refresh their memory without hitting "page down". As your reader continues through the document, they should receive a progressively greater amount of knowledge."
:checkered_flag: Table of Contents
Must be at least 3 level deep i.e. capture atleast upto heading 1, 2 and 3.
:cop: Security ⮭
(optional) Add any security vulnerability relevant data if applicable
:briefcase: Background ⮭
- Cover motivation if not already specified in "Long Description".
- Cover abstract dependencies.
- Cover intellectual provenance: A See also section is also fitting.
:cloud: Installation ⮭
$ npm install --global test-npm-app-cli # npm i -g test-npm-app-cli
$ npm install --save test-npm-app # npm i -S test-npm-app
:link: Dependencies ⮭
(optional) A brief description of notable dependent packages
:satellite: Updating ⮭
(optional) How to update and update instructions
- Link to prerequisite sites for language. [npmjs][], [godocs][], etc.
- Include any system-specific information needed for Installation.
- Subsection for dependencies needed for install to work.
:rocket: Usage ⮭
import testNpmApp from 'test-npm-app'
// OR
var testNpmApp = require('test-npm-app');
:computer: CLI ⮭
$ test-npm-app --options --flags --help
:nutandbolt: Extras ⮭
- Include background info if not specified in background section
- Include security related info if not specified in security section
:loop: API ⮭
Describe exported functions and objects.
- Describe signatures, return types, callbacks, and events.
- Cover types covered where not obvious.
- Describe caveats.
- If using an external API generator (like go-doc, js-doc, or so on), point to an external API.md file. This can be the only item in the section, if present.
:speedboat: Examples ⮭
List of examples
:bustsinsilhouette: Contribute ⮭
- State where users can ask questions.
- State whether PRs are accepted.
- List any requirements for contributing; for instance, having a sign-off on commits.
- Link to CONTRIBUTE.md file -- if there is one.
- Link to the GitHub issues.
- :bowtie: Link to Code of Conduct. This is often in Contribute, or organization wide, so may not be necessary for each module.
:hospital: Help & Support ⮭
Add links for getting help and support about this project.
:family: Contributors ⮭
This project follows the all-contributors specification.
:trophy: Sponsors ⮭
List of sponsors
Sponsoring mediums such as Patreon, etc.
:memo: License ⮭
:two_hearts: Related Projects ⮭
List of related projects
:ghost: Author ⮭
Tweet @abhisek
Know about/abhisekp
Chat with @abhisekp
[abhisekpAboutLink]: https://about.me/abhisekp
