typroa+picGo+docsify编写开发文档-woui项目配套教程

本文档介绍了如何使用Typroa Markdown编辑器,PicGo图床工具和Docsify框架来高效地创建和管理开发文档。Typroa提供实时预览,PicGo自动上传图片,Docsify则免去手动搭建文档项目的麻烦。通过配置Typroa与PicGo的关联,可以实现图片的无缝上传。而Docsify的使用则可以通过简单的命令快速启动项目,方便预览文档效果。
摘要由CSDN通过智能技术生成

前言

  • Typroa:一款markdown文档编辑工具,能提供实时的预览;
  • picGo :图床工具,帮助我们将typroa中图片自动上传至我们指定的图床
  • docsify :开发文档框架,免去手动搭建开发文档项目

一、Typroa 安装

typroa官网
在这里插入图片描述
根据自己的操作系统安装对应的安装包;

二、picGo安装及ms图床token创建

1.picGo 安装

picGo下载地址
在这里插入图片描述
根据自己的操作系统安装对应的安装包;

2.picGo+ms后续

为了不做重复性工作,这一步的剩余步骤参考这篇《解决picgo图片上传失败

三、typroa与picGo关联

点击“文件”-“偏好设置”,然后按照下图进行配置
在这里插入图片描述
tips:如果4中验证出现错误,也不一定是错误,这时,回到编辑器中随便粘贴一张图片,看看图片地址是否改变,如果地址显示的不是本地路径地址,那就是上传成功了。

四、docsify 安装及使用

这个就网上找一份教程即可,此处省略
贴几个常用命令:

  • docsify init [项目名称] :创建一个项目
  • docsify serve :运行这个项目

剩下的工作就是使用typroa进行文档的编写了,然后docsify serve 对文档进行预览,查看效果

内容比较简短,以后有时间再补充把

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值