errors
Failed to load YAML frontmatter: (<unknown>): mapping values are not allowed in this context at line 2 column 6

关于已有的开发文档迁移到新的文档系统的说明
已有的文档在这里： http://192.168.175.55:9888/TECH/tech-web-docs
新的文档系统在这里： http://192.168.175.55:9888/appDev/iidp-docs

1、迁移的目的

主要有两个目的：一个是好看，另一个是方便搜索。
因为新的文档系统界面看起来比较美观，而且支持全文索引。

img.png

2、迁移的方式

  • 我们先看看已有的文档系统是如何做的？

img_3.png

由上图可知，定位一个md文件是通过人工指定该md文件的目录路径。

  • 我们再看看新的文档系统是如何做的？

img_4.png

img_6.png

img_5.png

由上图可知，定位一个md文件是通过人工指定该md文件的唯一标识，这个唯一标识是在md文件中自动生成的， 而且进入任何一个md文件，那么整个的目录结构都会显示出来，这样就可以方便的定位到任何一个md文件。

整个的流程是：首页的开发文档 –> 快速上手 –> 正文。
相当于说在正文和首页间加了一个二级索引。

  • 最后我们预估一下迁移需要的工作量
  1. 将所有的原md文档复制粘贴到新的文档系统；
  2. 将已有的目录命名方式统一修改成 01 02 03 … 这种形式；
  3. 将之前用目录区分的md文件统一放在一个文件夹下，比如说：02.快速上手，该文件夹下的都是关于快速上手的内容，不需要再建文件夹；

  4. 重新调整链接图片的地址，因为旧的文档系统是直接 images/xxx.png 这种形式，需要修改成 ./images/xxx.png 这种形式； 为什么要做这种修改呢？本质上是因为新旧文档系统是完全不同的。新的文档系统编译后的目录结构是这样的： img_7.png

    所以，新的文档系统正确的索引图片的方式是：/img/xxx.png 但是为了减少迁移的工作量，且为了方便本编写md文件时可以预览，使用 ./images/xxxx.png 是可以的，也是我个人比较推荐的。 另外，图片路径不要使用中文，否则build会报错。 img_8.png

Table of Contents