write skill

[amenzai]

README 写法

简单项目

• Introduction(add visite link)
• Technology stack

---

• 项目名（加些描述、版本信息等）[实用开发的工具 库等]
  • Installation
  • Usage：使用
  • Example Usage：示例用法
  • Warning
  • Explain：解释说明
  • License

---

• Features：功能特色

• Browser Support

• Installing

• Example

• Api

• Changelog

• Installation

• Quick Start

• Internationalization

• Custom Theme

Guide Resource Contribution FAQ Donation Sponsors(赞助商)

# Using npm:
$ npm install axios

#Using bower:
$ bower install axios

# Using cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

how to use

First of all, check your Node version.

$ node -v
v8.0.0

Koa requires node v7.6.0+. If your version is older than that, upgrade Node first.

Then clone the repo (or download zip file).

$ git clone git@github.com:ruanyf/koa-demos.git

Install the dependencies.

$ cd koa-demos
$ npm install

Now play with the source files under the demos directory.

教程资料

Foreword: （尤指非作者本人撰写的）前言，代序 preface: 前言

1. 简要描述
2. || Related Projects（有关联项目，可以加这个）
3. title How to use
4. title Index
5. title Demo01: start a server(正文可以添加：demo / source 源码连接)
6. ...
7. title Useful links
   1. link text, by xxx author
8. title License(BSD licensed)

培训材料

1. description
2. 要求
3. 环境准备
4. 小练习
5. 第一讲
   1. xxx
   2. xxx
6. 第二讲
7. License

软件手册

• 简介（Introduction）： [必备] [文件] 提供对产品和文档本身的总体的、扼要的说明
• 快速上手（Getting Started）：[可选] [文件] 如何最快速地使用产品
• 入门篇（Basics）： [必备] [目录] 又称”使用篇“，提供初级的使用教程
  • 环境准备（Prerequisite）：[必备] [文件] 软件使用需要满足的前置条件
  • 安装（Installation）：[可选] [文件] 软件的安装方法
  • 设置（Configuration）：[必备] [文件] 软件的设置
• 进阶篇（Advanced)：[可选] [目录] 又称”开发篇“，提供中高级的开发教程
• API（Reference）：[可选] [目录|文件] 软件 API 的逐一介绍
• FAQ：[可选] [文件] 常见问题解答
• 附录（Appendix）：[可选] [目录] 不属于教程本身、但对阅读教程有帮助的内容
  • Glossary：[可选] [文件] 名词解释
  • Recipes：[可选] [文件] 最佳实践
  • Troubleshooting：[可选] [文件] 故障处理
  • ChangeLog：[可选] [文件] 版本说明
  • Feedback：[可选] [文件] 反馈方式

[amenzai]

markdown can use dom

Supporting Vue.js