看vue3源码可以学到什么 : 一 、README

前言

尤神发布vue3源码已经有大半个月，不少好奇且习惯早起的鸟儿都已经clone好大神代码的汲取养分了。作为其中的一只，再此将膜拜中的过程及收获汇沉淀汇总，以期形成一个系列提升自己。

本文作为系列第一章，将介绍开源项目必须对准开首枪的内容 README.

内容

Vue3 Readme主要内容如下

• circleci。readme开始的第一行circleci链接,那么什么是circleci呢，一款进行持续集成，持续部署的平台。类似的工具或者平台有比如jekins,Travis CI，TeamCity，GitLab CI等等。不同的公司或者开发者因开发规模，应用类型不同使用满足各自需求的相应的工具平台。对于没有使用或者完全没有持续集成，部署概念的同学此处可以多了解一下。

image

• 当前状态 Pre-Alpha。如果有版本概念的同学此处可以略过，没有的可以点此软件版本了解巩固一下，后续发布公司或者个人的项目时注意版本及命名等区分。
• 特性功能说明 vue3 Readme里的主要内容是架构目标及新特性的说明。可以简单了解

 编译器:
 1.使用模块化架构
 2.优化 "Block tree"
 3.更激进的 static tree hoisting 功能
 4.支持 Source map
 5.内置标识符前缀（又名 "stripWith"）
 6.内置整齐打印（pretty-printing）功能
 7.移除 source map 和标识符前缀功能后，使用 Brotli 8.压缩的浏览器版本精简了大约 10KB
运行时:
 1.速度显著提升
 2.同时支持 Composition API 和 Options API，以及 typings
 3.基于 Proxy 实现的数据变更检测
 4.支持 Fragments
 5.支持 Portals
 6.支持 Suspense w/ async setup()

image

• 贡献方式 该链接对应完整的开发者贡献指南,有更为详尽的产品概念文档，项目架构，开发配置项，issue反馈指南，捐赠指南。对于想一窥源码究竟的同学有较高的价值可以仔细阅读。对于已经开发有自己开源软件的同学，捐赠指南也可以果断参考学习。
  image

image

收获关键词

circleci 软件版本 捐献指南 markdown 持续集成，持续部署

发散问题

• 平时工作中我们大部分是做业务开发，那么业务项目中如何管理维护文档，文档应该包含哪些内容，从哪些方面着手？
• readme现在都是采用markdown格式。那么markdown的解析方式是怎么样的？如何实现一个markdown?

以上两个问题，平时在工作中有了解或者最佳实践的同学也可以不吝分享一起探讨提高