最近公司开发项目需要前后端分离，这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用，因此编写API文档非常有必要了 网上查了很多资料，发现基于Markdown编写文档是一种比较流行而且成熟的方案了，话不多说，我也搞一搞试试。 电脑操作系统：deepin深度 Linux64位 ...

　　　　　　　　　　　　　基于typora编写Markdown文档 　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　作者：尹正杰 版权声明：原创作品，谢绝转载！否则将追究法律责任。 　　去年我有些过关于Markdown语法的文档，今天我就来 ...

首先安装vscode工具，具体的使用可以参考之前的博文：《Visual Studio Code教程：基础使用和自定义设置》 VScode已经默认集成markdown文档编辑插件。可以新建一个.md文件Visual Studio Code 原生就支持高亮Markdown的语法，想要一边编辑 ...

首先安装vscode工具，具体的使用可以参考之前的博文：《Visual Studio Code教程：基础使用和自定义设置》 VScode已经默认集成markdown文档编辑插件。可以新建一个.md文件Visual Studio Code 原生就支持高亮Markdown的语法，想要一边编辑一遍预览 ...

博客园里讨论编程的文章很多，却没有见过谁发表过文档撰写方面的，或者有，是有我不知道呢？但无可否认的是，涉及到到文档方面的极为罕见。这是否与程序员对文档的编写不够重视有关呢。 作为一名程序员，我也曾经犯这样的错误，对于文档的编写不够重视。但是长期地和客户接触中，发现文档的撰写极为重要，出色文档 ...

使用 markdown 格式书写文档 只使用一二三级标题，三级标题下面的并列性内容使用列表展示 二级标题前使用行分隔符表示分隔 段落之间使用一个空行隔开 一句话或者以逗号分隔的句子，长度尽量保持在 20 个字以内，20～29 个字的句子，可以接受 禁止文字口语化 ...

用Typora写Markdown文档，发现在用了列表后，回车想再开一段的时候，会带有列表序号，删除后只能和列表段对齐，缩进有问题。 解决方法： 想要另起一行时直接按两次回车。 或者使用command + [ 解决 网上的其他解决方法： 回车的时候用Shift+Enter光标 ...

1、准备工作 下载vscode、node.js npm安装docsify，docsify教程 npm i docsify-cli -g 切换到程序目录运行 docsify serve docs 2、编写api文档 3、查看效果 4、代码已 ...