如何最简单的在项目里面放一个结构化的说明文档

前提背景

产品：项目上需要一个经常更新变化的文档页面。
UI：难道每次变化我都要出新图吗？
前端：不想为了这样的静态文档页面随时投入精力调整样式或者修改文案… …
产品：我想要自己随时编辑… …
前端：难道我要为你这个在项目上加一个支持富文本编辑的控件？
产品：那只能我来编辑，别人不行！
后端：啥？我还要给你这个账户加一个特殊的专门编辑文档的权限

呃… …小需求而已，搞那么复杂

思路

产品用markdown编辑文件.md，把文件.md给开发，转换成html，放在静态资源文件里面访问，随时替换更新

方法

以编辑器vscode为例
搜索 Markdown Preview Enhanced插件并安装 （推荐产品也用这个✌️）

打开.md文件,上面有两个按键（一个白背景，一个黑背景），点击可预览html，

在预览页面右键可在相同位置生成html文件

放在静态资源管理处，直接访问或iframe嵌入

<a href="@/assets/README.html" target="_blank">查看文档</a>