开始之前 是不是在github上看项目的时候第一眼就要看项目介绍? 是不是经常在某些项目的代码里面看到一个README.MD文档 却不知道怎么写? 你是不是不知道,反正我是的. 作为一个程序员,可能写了几年之后都会或多或少的需要写一份可以帮助别人快速了解你的项目的文档,这个时候如果你用txt或者word来写 ,是不是有点不够逼格,又或排版略显麻烦? 那么它来了 -- MarkDown Markdown是一种轻量级的标记语言,使用极为简单的语法就可以实现 段落,文字字体,超链接,图片,代码块,表格…

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出…

背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma…

word中怎样把文档里的中文以及中文字符全选? 参考: 百度 案例: 有个文档是中英文混杂的 现在需要把中文以及中文字符全部设置成别的颜色 应该怎样操作? 有80多页 别说让我一个一个的设置 以word2010为例操作步骤如下: 1.启动word,打开要操作的文档: 2.按ctrl+h快捷键打开查找和替换对话框,点击查找选项卡: 3.查找内容输入[!^1-^127],点击更多按钮,勾选下方选项使用通配符: 4.点击在以下项中查找,弹出菜单选择主文档: 5.效果如下图:…

Markdown是一种纯文本格式的标记语言.通过简单的标记语法,它可以使普通文本内容具有一定的格式. 为啥要用 MarkDown 呢? 优点 1.因为是纯文本,所以只要支持Markdown的地方都能获得一样的编辑效果,可以让作者摆脱排版的困扰,专心写作. 2.操作简单.比如:WYSIWYG编辑时标记个标题,先选中内容,再点击导航栏的标题按钮,选择几级标题.要三个步骤.而Markdown只需要在标题内容前加#即可 缺点 1.需要记一些语法(当然,是很简单.五分钟学会). 2.有些平台不支持Mark…

Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md-demo 安装 全局 npm install -g spec-md 本地项目依赖 npm install --save-dev spec-md 项目使用 因为个人原因,比较喜欢使用yarn,所以项目基于yarn 初始化 初始化 yarn init -y 配置构建&&依赖 yarn add s…

换行:在结尾加两个空格后回车. 缩进:将输入法切换到全角,两个空格就是两个汉字的大小.…

在文档结构图的侧栏里按住control+option,然后滑动鼠标滚轮/双指上下滚动触摸板.…

要引用活动的段落.表格.域或其他文档元素,可使用 Selection 属性返回一个 Selection 对象.通过 Selection 对象,可访问选定内容中的所有段落或第一段.下列示例将边框应用于选定内容的第一段. Sub BorderAroundFirstParagraph()    Selection.Paragraphs(1).Borders.Enable = TrueEnd Sub下列示例将边框应用于选定内容中的每一个段落. Sub BorderAroundSelection()   …

接口名称 1) 请求地址 https://apis.cnblogs.com/user/info?a=xx&b=xx 2) 调用方式:HTTP GET 3) 接口描述: 接口描述详情 4) 请求参数: GET参数: 字段名称 字段说明 类型 必填 备注 a string Y - b string Y - 5) 请求返回结果: { "errNum": 10001, "errMsg": "Param error" } 6) 请求返回结果参数说明…