作为技术开发,大家平时肯定需要记录技术笔记。甚至有的同学还开通可自己的技术博客或者技术公众号进行创作。

这个时候有套趁手的写作工具尤为重要,节省下时间好好休息一下,对于咱们程序员来说更加重要。因为最近在自己学习golang,为了找个顺手的IDE尝试了一下VScode,用后总结两个字:“真香”。集编码、写作、划水 于一身。

话不多说,我们今天先说说写作这部分。

文字内容

文字写作推荐大家使用markdown。大家的经历应该主要放在文字内容上,可以节省大家的排版时间。虽然marakdown的语法非常简单,但是一款趁手的markdown编辑器也非常重要。因为今天的主角的VScode,所以大家可以直接在安装VScode中安装一下markdown插件即可,比如:

  • Markdown All in One

  • markdownlint

现在大部分博客平台都支持markdown,可以直接讲我们写的内容复制过去,可惜的是公众号现在还不支持。所以要借助Md2all在线渲染网站,可以一键复制到公众号,并且还可以美化一些样式,比较简约美观一些。还可以选择不同主题或者自己改一些CSS样式,像下面这样:

图片内容

技术写作经常会画一些流程图,架构图。尤其图解会然让复杂的问题更加直观,更容易理解。所以有个方便的画图软件很重要。原来阈值用processon在线画图,但是因为个人免费用户有文件个数限制,所以不太友好(还是因为穷,哈哈哈)。最近一直用draw.io,并且支持将文件自动存储到github,用起来很方便。尤其现在VScode还有对应的插件,写字、画图都在一个编辑器里,沉浸感更强了,防止思路再来回切软件时被打断。下面时再VScode里创建一个drawio文件:

画完图导出为图片,然后借助PicGo插件+github+jsDelivr(不了解的同学可以搜索一下,网上很多详细文档),自动上传图片到github图床并自动插入到markdown文件中。VScode也有PicGo对应的插件,所以这些操作也全再VScode中完成,很方便。

代码

Talk is cheap. Show me the code.

对于文章中的代码,有人习惯用markdown本身的代码片段,也有人习惯放代码截图。但是截图很难截的统一大小,导致不太美观。这里推荐用插件Polacode-2020。

可以把代码保存为统一大小的图片,然后使用图片部分的插件,自动将代码图片插入到文章中。

最后我们再把上面提到的插件汇总一下,希望对你的写作有所帮助:

  • Markdown All in One
  • markdownlint
  • Draw.io intergration
  • PicGo
  • Polacode-2020

大家如果喜欢,记得关注哦。

把vscode打造成技术写作神器的更多相关文章

  1. vscode插件(摸鱼神器-小霸王游戏机

    vscode插件(摸鱼神器-小霸王游戏机 步骤 vscode扩展搜索小霸王,点击下载即可. 使用 默认有一个demo小游戏,即超级玛丽. 本地仓库 可以通过local菜单上的添加按钮添加本地nes r ...

  2. 蒲公英 · JELLY技术周刊 Vol.13 跟 VSCode 学习如何开发大型 IDE 项目

    开发一个 IDE 很难么?这或许是件很难的事情,但当我们参考 VSCode 的技术构架来看,整个开发流程就会平滑顺畅很多,从内核开发.代码编辑器.视图结构到插件系统,在这整个技术构架中我们可以看到很多 ...

  3. Excel阅读模式/聚光灯开发技术之二 超级逐步录入提示功能开发原理简述—— 隐鹤 / HelloWorld

    Excel阅读模式/聚光灯开发技术之二 超级逐步录入提示功能开发原理简述———— 隐鹤  /  HelloWorld 1. 引言 自本人第一篇博文“Excel阅读模式/单元格行列指示/聚光灯开发技术要 ...

  4. Atom:优雅迷人的编辑神器

    对于热爱markdown写作的人来说,Atom同样是一款拥有无穷魅力的写作软件.我不怕它无法满足你的需求,就怕你不给一个机会了解它,那么,这将是一场遗憾的错过. 大学的时候,坊间对那些编程高手有一个令 ...

  5. 提升Essay写作说服力,需要注意这几个细节

    很多留学生对于essay写作都不精通,能够勉强通过就不错了.那么Essay写作到底该怎么提分呢?可以从哪些方面入手?小编给同学们指几条路,相信可以帮到大家. 在有说服力的Essay中总结您的论点.尽管 ...

  6. 四个因素决定Essay写作段落长度

    段落是一篇Essay的基石,写好Essay应从写好段落开始.那么Essay写作中一个段落多长为好?英语和修辞学教授理查德·诺德奎斯特著文介绍了一些专家的观点.从以下的译文可以看到,段落长度虽然没有固定 ...

  7. [zz]有哪些优秀的科学网站和科研软件推荐给研究生?

    https://www.zhihu.com/question/37061410 如题,各位科研前辈,有没有一些好的科研网站或者适合科研人员用的软件以及APP,推荐给一只研一的菜鸡,帮助我们提高科研效率 ...

  8. 东哥读书小记 之 《MacTalk人生元编程》

         一直以来的自我感觉:自己是个记性偏弱的人.反正从小读书就喜欢做笔记(可自己的字写得巨丑无比,尼玛不科学呀),抄书这事儿真的就常发生俺的身上. 因为那时经常要背诵课文之类,反正为了怕自己忘记, ...

  9. 使用Python从Markdown文档中自动生成标题导航

    概述 知识与思路 代码实现 概述 Markdown 很适合于技术写作,因为技术写作并不需要花哨的排版和内容, 只要内容生动而严谨,文笔朴实而优美. 为了编写对读者更友好的文章,有必要生成文章的标题导航 ...

随机推荐

  1. 配合php伪协议利用文件包含漏洞

    文章来源: https://blog.csdn.net/zpy1998zpy/article/details/80598768?utm_medium=distribute.pc_relevant.no ...

  2. Codis集群相关

    在大数据高并发场景下,单个 Redis 实例往往会显得捉襟见肘.首先体现在内存上,单个 Redis 的内存不宜过大,内存太大会导致 rdb 文件过大,进一步导致主从同步时全量同步时间过长,在实例重启恢 ...

  3. 说说 Python 中的高阶函数

    高阶函数(higher-order function)指的是:接受一个函数为参数,或者把函数作为结果值返回的函数. 1 sorted() 比较常见的高阶函数是 sorted(),其内部的关键字参数 k ...

  4. VS中使用RDLC提示类型不一致

    问题描述 错误"基类包括字段"XXXXXXX",但其类型(Microsoft.Reporting.WebForms.ReportViewer)与控件(Microsoft. ...

  5. Autofac官方文档翻译--一、注册组件--3属性和方法注入

    官方文档:http://docs.autofac.org/en/latest/register/prop-method-injection.html Autofac 属性和方法注入 虽然构造函数参数注 ...

  6. 安装篇一:安装VMware12

    #1.安装VMware12 前提:安装不了的解决办法(进入BIOS系统,把虚拟化技术那一项修改为enable) 说明:安装流程(自定义安装)              #2.网络适配器设置 虚拟网络编 ...

  7. python初学者-水仙花数简单算法

    输出"水仙花数".所谓水仙花是指一个3位数的十进制数,其各位数字的立方和等于该数本身.例如:153是水仙花数. 用for循环实现水仙花数的计算图如下所示: 1 for i in r ...

  8. 如何优雅的将Object转换成List

    Main主函数中的 Object obj模拟了List对象.后续的代码首先判断obj是否是List类型,然后使用Class.cast做类型转换. 如果你想使用更方便的方法,可以直接调用下面的函数. p ...

  9. springMVC框架连接数据库查询数据

    1.框架搭建,创建一个maven项目打war包 web.xml文件 <?xml version="1.0" encoding="UTF-8"?> & ...

  10. @Transient 注解

    使用 @Transient 表示该属性并非是一个要映射到数据库表中的字段,只是起辅助作用.ORM框架将会忽略该属性