Background 项目背景
Features 功能特色
Structure 项目结构
Requirement 环境基础
Install 安装
Usage 如何使用
Examples 使用案例
Maintainers 维护者
Contributing 贡献者
Common-issues 常见问题

背景介绍

介绍当前组件或者项目的作用，以及功能

Install

  1. npm install --save-dev webpack

使用

提供一些简易的Demo

  1.  new Vue({...})

目录结构描述

├── Readme.md // help
├── app // 应用
├── config // 配置
│ ├── default.json
│ ├── dev.json // 开发环境
│ ├── experiment.json // 实验
│ ├── index.js // 配置控制
│ ├── local.json // 本地
│ ├── production.json // 生产环境
│ └── test.json // 测试环境
├── data
├── doc // 文档
├── environment
├── gulpfile.js
├── locales
├── logger-service.js // 启动日志配置
├── node_modules
├── package.json
├── app-service.js // 启动应用配置
├── static // web静态资源加载
│ └── initjson
│ └── config.js // 提供给前端的配置
├── test
├── test-service.js
└── tools

可以加入 Link and Img

Link标签
README.md 规范 - 图1

一级标题
##二级标题
###三级标题

https://www.zybuluo.com/mdeditor 在线READM.md

  1. Background  项目背景
  2. Features  功能特色
  3. Structure  项目结构
  4. Requirement  环境基础
  5. Install  安装
  6. Usage  如何使用
  7. Examples  使用案例
  8. Maintainers  维护者
  9. Contributing  贡献者
  10. Common-issues  常见问题
  14. # 背景介绍
  15. 介绍当前组件或者项目的作用，以及功能
  17. ## Install
  19. ```bash
  20. npm install --save-dev webpack

使用

提供一些简易的Demo

  1.  new Vue({...})

目录结构描述

├── Readme.md // help ├── app // 应用 ├── config // 配置 │ ├── default.json │ ├── dev.json // 开发环境 │ ├── experiment.json // 实验 │ ├── index.js // 配置控制 │ ├── local.json // 本地 │ ├── production.json // 生产环境 │ └── test.json // 测试环境 ├── data ├── doc // 文档 ├── environment ├── gulpfile.js ├── locales ├── logger-service.js // 启动日志配置 ├── node_modules ├── package.json ├── app-service.js // 启动应用配置 ├── static // web静态资源加载 │ └── initjson │ └── config.js // 提供给前端的配置 ├── test ├── test-service.js └── tools

可以加入 Link and Img

Link标签 图片

一级标题

二级标题

三级标题

https://www.zybuluo.com/mdeditor 在线READM.md ```