看云文的坑

看云文的坑

2021 第一天给大家来点填坑的干货

这篇其实我是想在元旦之前写完的,但是没想到拖延到现在,拖延症还是得继续治。

事情呢是这样的,现在很多公司或者个人输出文档都采用在线编辑工具,平台有很多这里不不一一举例了。目的都是在线编辑保存即可发布,完善的版本管理可追溯,外加md的通用格式在转换成html文档即可在线阅读。

也可以根据自己的需求安装客户端,这个就得看每个平台的支持了,但是话说回来你要是在手机上编写MD文档这就是自己找不痛快了哈。

问题是这样的,我司呢因为做一些开源项目,为了和外界更好的沟通,就采用看云这个平台来编写开源项目的文档,以便更多开发和技术爱好者翻阅。其实这个功能单一的看他【看云】已经很完美了。

但是站在软件开发的角度,很多程度上一个软件的产出可能在下一个环境是要使用的,这个只要做过开发的同学肯定深有体会。

那么现在需求来了,就是将看云的文档同步到gitee【码云】的项目Wiki【项目文档】中,那么我们的文档是在看云上编写的啊,为了更好的维护开发在码云上在写一遍肯定不现实,当然有人想这么做我也没办法,哈哈哈哈。

找方法

看云既然有版本控制,那么肯定基于svn 或者 git 实现的,找找看,终于不辜负有心人

看云文的坑_第1张图片

看云文的坑_第2张图片

是的上面就是看云文档的版本控制地址,他既然提供这个地址那么肯定支持 git 的一系列操作,他敢提供 我就敢用,是的,我一直都是这么干的,哈哈哈哈。

开干

是的 先 clone 看云文档到本地 再添加一个码云的远程 push 地址不就可以实现看云和码云gitee 的 wiki 文档库同步可么,哈哈哈,我就是个天才,(程序员就是懒)。

同步完木之后的我看着有点傻了,这目录咋和看云的目录不一致呢?什么鬼,一步步探探究竟。

看云文的坑_第3张图片

找到了猫腻

看云文的坑_第4张图片

如果你也有遇到过得话,或者准备做上面事情的话,你 会发现 上面截图的文件其实是一个目录索引文件,暂且不管他的格式与名称我们先看看他的实现规则,就是在你创建的时候在对应的层级添加一个节点,再在对应的目录下创建一个md文件

举个栗子

  • [菜单名称] (菜单对应的地址)

是的就是上面的这个格式,那么问什么有的层级不对应也就是说

image-20210101223940902

就因为层级不对才导致这个问题, 遇见问题不能退缩啊,怎么解决呢?继续找,干。

看云文的坑_第5张图片

层级乱的错误怎么产生的呢

一顿查找和实验发现,看云在第一次创建是就定死了文件位置,即使你使用它的隐藏技巧,拖动目录的方式,你会发现拖动后目录看起来更新了,但原本的目录还在原来的层级,只是菜单位置更改了而已,文件的指向没有根据拖动而动。

因为这个操作截图困难我就不演示了,左键按住要拖动的层级,稍微往右一点点再上下活动你会看见一个淡绿色的箭头,松开时箭头在哪更新位置就在哪里,这个操作需要有点姿势要求的哈!慢慢体会!

补救方式

既然遇到问题咱就解决么,既然你根据这个目录索引文件,那么我可以根据目录层级整理文件实际的位置,这样就能和目录对象上,无论我上传到哪个doc形式的服务后也不至于目录大乱套,这样就能解决我的最大问题,至于这个SUMMARY.md的文件文件我们可以后面研究。那么问题找到了。说干就干

一顿键盘和目录的对应以及附件层级整理

看云文的坑_第6张图片

看云文的坑_第7张图片

看云文的坑_第8张图片

对么这样看着就舒服多了

看看结果

看云文的坑_第9张图片

为什么没用复制粘贴

这也是一种办法,但clone看云之后再copy到码云项目对应的wiki 要是文档最后一次更新还好,如果频繁更新想想都头疼,这么干肯定是个体力活了。对于极客 哦不 对于懒惰的我肯定不会这么干。

结语

使用上面的方式我不仅仅整理的看云的文档还将文档可以同步到任何以MD格式为Doc的服务上,想想都爽的不要不要的。

遇到问题别慌,肯定有解决方式。

我是用VSCode更改和编写MD文档的,当然素材都是之前的,后面如果继续用本地写MD同步到看云或者其他平台我再看看这个图片咋么弄,不行就搞一个图床。哈哈哈,想想好像又入了一个坑。

2021-01-01 祝大家平安健康,世界上没有新冠。

看着大家都在写年终总结和下一年的规划,其实我自己发自内心的我是想在春节前完成我的总结和下一年的计划。骨子里还是个认阴历的人。觉得春节才是一年的界限。哈哈哈。


微信搜索 公众号 "西北大粽子" 每周持续更新2-3篇原创内容,第一时间了解最新文章。

你可能感兴趣的:(文档)