作为一个vim使用者,编写markdown文档时若不能用vim这怎么能受的了! 下面是我编写markdown的时候用到的插件 Plugin 'Markdown'Plugin 'Markdown-syntax' Plugin 'SirVer/ultisnips' 这三个插件的安装与介绍我就不累述了,网上一大堆. ps.第三个插件的安装使用可参考我之前的文章 下面我介绍一下怎么利用补全插件,修改snippets,方便我们编写markdown文档. 首先,网上存在这样的一篇文章 http://www.…
如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构可以提供追溯其他工作产品的上下文. 有文档的架构可以传达可供选择的架构解决方案. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构可以提醒架构师在其所作的某些决定背后的…
假设你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",增加这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的优点是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构能够提供追溯其它工作产品的上下文. 有文档的架构能够传达可供选择的架构解决方式. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构能够提醒架构师在其所作的某些决定背后的…
最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出…
Vim8.0是近十年来的一次大更新,支持任务.异步I/O.Channels和JSON以及异步计时器.Lambdas 和 Closures等,还包括对GTK + 3的支持.由于ubuntu默认安装的Vim版本一般都是7.4.52,该版本不满足许多vim插件的需求(如YouCompleteMe),因此需要升级Vim到新版本. 1. 源码编译安装vim8 Ubuntu下源码编译安装Vim8的方法如下: 1234 git clone https://github.com/vim/vim.gicd vim…
1.home/.vimrc是用户自己的vim配置文件,在这个配置文件中设置的配置只影响该用安装前的准备工作: 在home目录下列新建文件夹  : .vim ------------------>.vim是一个隐藏文件,不要漏了 “.” .vim/plugin ---------->.vim目录下的plugin文件夹 .vim/doc ------------->.vim目录下的doc文件夹 .vim/syntax --------->.vim目录下的syntax文件夹 在home目…
使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API 接口文档工具,通过注释定义接口和模型,可以和代码文件放置一起,也可以单独文件存放. 优势 通过代码注解定义文档,更容易保持代码文档的一致性 模型复用,减少文档冗余,带来更可靠的文档 提供客户端访问接口,可以直接调试接口,不需要第三方工具进行调用测试接口 支持权限认证,等功能 Laravel Swa…
1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这个坊间口碑,但是使用起来并不舒心-原因如下: 笨重,每次打开md文档都需要等待软件启动 无法预览效果,需要安装额外的软件Awesomium 打开文档,预览显示一片空白也是常事 2. Notepad++ 免费 轻量 插件众多 台湾同胞开发 支持众多语言风格的展示(可以集成编辑各类文档) 3. 搭建编写…
作为一名优秀的Java开发工程师,编写接口文档向来是一件很头疼的事情.本来就被bug纠缠的很累了,你还让我干这? 其实,你可以试试ApiPost. ApiPost的定位是Postman+Swagger+Mock Server,主要用来发送调试接口和生成接口文档.如果你愿意,也可以用它生成Mock 数据,当Mock Server使用. 下面就简单介绍如何利用ApiPost调试接口和快速的生成接口文档,让您初步体验ApiPost的魅力! 1. API写完想要测试?试试模拟发送一次请求 新建接口,我想…
背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma…