docsify编写类似vue风格文档

docsify编写类似vue风格文档,第1张

作为一名 java 后端开发人员,习惯编写 markdown 技术文档。希望写的资料可以通过个人网站保存,便于日后查看,我们有很多工具如:GitBook,Hexo 这类偏向博客风格网站工具。这里我们使用docsify文档工具,结合github pages功能可以发布为在线文档网站,而且提交会自动更新网站。

该工具用于创建及本地预览文档网站。安装成功后

这里建的文件夹: lsy-notes ;对应目录 /Users/lxxx/Documents/my-documentweb/docsify/lsy-notes 。
切换到新建文件目录下,初始化站点信息: docsify init /docs ,实际上这里可以直接 docsify init / , 将当前目录为文档主目录。

会在当前目录下生成 docs 文件夹。其实这个文件夹就是将来我们存放 md 格式的博客文件的地方。 docs 文件夹下生成3个文件如下:

在当前目录下执行: docsify serve /docs

浏览器打开: >文件是用和来表示
文件扩展名,对于使用电脑的菜鸟们来说,这或许是个非常陌生的名字。也许很多人都要问,文件名就文件名塞,还什么扩展名哟?然而在我们实际应用中就经常会遇到一些这样的现象:电脑中一些莫名其妙的文件总是打不开,及时打开了怎么图标总是和别人计算机里面的不一样等等。废话少说了,言归正传。
文件扩展名 是 *** 作系统用来标志文件格式的一种机制。通常来说,一个扩展名是跟在文件名后面的,由一个分隔符分隔。在一个像“readmetxt”的文件名中,readme是文件名,txt为扩展名,表示这个文件是一个纯文本文件。
也许你们会问:我打开电脑怎么没有看见文件名后面有一个原点和原点后面的东东呢?不要着急,跟我来哟?首先打开一个文件夹,单击菜单栏→工具→文件夹选项
去掉"隐藏已知文件的扩展名"前面的勾点击确定,这下你看看你电脑里面保存的所有文件,是否在原来文件名后面都多了原点和一些字母符号呢?这些都是扩展名。如果想不显示扩展名,就执行刚才上面的步骤,把刚才去掉的那个√打上,点击确定就OK了,大家可以多多练习这个哦。
不过大家千万要注意,在我们取消√以后,文件名及其扩展名就显示出来了,但是当我们需要重命名的时候,文件扩展名是不能更改的哟,否则可能就打不开该文件了哟,或者该文件的图标就变样了。所以,我们在重命名带扩展名的文件时,扩展名是不能丢的。
我们经常接触的扩展名有doc(Word文档)、wps(Wps文档)、xls(Excel电子表格)、ppt(Powerpoint演示文稿)、jpg()、txt(纯文本)、rar(Winrar压缩文件)、htm(网页文件)、html(网页文件)等等。
这下大家是否清楚了吗?如果大家还迷糊儿的话,我再来费了哈。我们可能都使用过Word编辑过文档的,在我们辛辛苦苦打了一篇文章或总结计划之后,我们接下来的事情就是保存,在我们点击保存的时候,就会d出如下对话框,在保存类型那个地方,我们时候会看见word文档这一标志呢?也许我们绝大多数人不回去在意这个问题(否则我们大家都是发明家了哟),因为我们的绝大多数老师都没有教哟,所以我们只取一个文件名就OK了。就是我们没有在意的那个地方就是文件扩展名。
以上资料来自互联网

GitHubPages。
现在大多程序员都会使用通用代码库Github,所以对于希望保存文档的程序员来说,Github是一个不错的选择,尽管很多人只是利用代码库中的readme功能来为项目提供简单的 *** 作指南,但这并非是最好的办法。
ReadtheDocs。
顾名思义,ReadtheDocs为开发人员提供了一个集中的平台来保存文档,这样用户就可以直接阅读文档了。它的工作原理有点类似GitHubpages,因为开发人员可以从他们喜欢的版本控制系统(包括Git、Bazaar、Mercurial等)中推送文档更新。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/13252317.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-06-26
下一篇 2023-06-26

发表评论

登录后才能评论

评论列表(0条)

保存