前端开发文档平台搭建

为什么要做前端开发文档平台?

随着业务和项目的日益增多，我们经常需要对一些常用的、功能相似的组件和方法做封装，抽象成公共组件。以便在各个项目、各个页面中使用，不光是自己使用，也可以给其他人使用。那别人怎么使用你的组件和方法，不能每次都来请教你，或者去扒源码，效率低，问的多了也会影响到你的工作。所以如果有一个平台可以看到公共组件的使用说明，不仅对使用者方便，同时也可以减少组件开发者的工作。

前端开发文档平台的作用

对使用者：

• 方便使用者查找现有组件，减少重复开发工作。
• 方便使用者快速了解组件的使用，降低使用门槛，提高开发效率。

对开发者

• 减少开发者的解释说明工作，提高效率。
• 在写文档过程中会重新梳理组件，从使用者角度思考组件的易用性，对开发者是一次提高

技术选型

在技术选型的时候应考虑以下几个因素：

• 是否满足搭建前端开发文档平台的需求
• 技术成熟度
• 社区活跃度
• 目前团队技术栈、上手难度
• demo验证

结合上面所说，选择的技术方案为vuepress。

vuepress的优势：

• 内置markdown扩展，针对技术文档进行了优化，可以在markdown中内嵌vue代码。
• 成熟的框架体系，配套的主题、响应式布局、导航栏、侧边栏、搜索等。
• 活跃的社区，丰富的第三方插件。
• 以Vue为核心驱动，且可高度可定制。