首先安装vscode工具,具体的使用可以参考之前的博文:<Visual Studio Code教程:基础使用和自定义设置> VScode已经默认集成markdown文档编辑插件.可以新建一个.md文件Visual Studio Code 原生就支持高亮Markdown的语法,想要一边编辑一遍预览,有两种方法:1.Ctrl + Shift + P 调出主命令框,输入 Markdown,应该会匹配到几项 Markdown相关命令 2.先按Ctrl + K,然后放掉,紧接着再按 v,也能调出实时预览

SDWebImage ReadMe.md 文档 附:SDWebImage框架github下载地址:https://github.com/rs/SDWebImage 注1:该文章简单翻译了SDWebImage最新版本(3.8.1)的readMe.md,时间紧促,如有不当请指正修改,十分感激. 注2:对该框架的学习将持续进行,在个人的github地址可以得到最新进展. Web Image 版本3.8.1|平台iOS|开源协议MIT| 该库为UIImageView提供了一个分类来处理远程图片资源的加载

目录 Python之文件处理-批量修改md文档内容 Python之文件处理-批量修改md文档内容 #!/usr/bin/env python # -*- coding:utf-8 -*- import os import re import time def modify_md_content(top): for root, dirs, files in os.walk(top, topdown=False): # 循环文件 for file_name in files: file_name_s

对<md文档的书写一>的补充和部分归总 我使用的是Typora,快捷键可能有些片面,没有特殊说明,下文所有快捷键都是Typora编辑器下支持的快捷键,望知晓. 关于标题的书写补充 除了 (n)个#空格加标题内容的方式,还可以使用快捷键Ctrl+(1-5)生成相对应级别的标题,支持到五级标题,六级标题需要使用多个#号开头的方式生成. 另外一种方式:是在无格式下输入标题内容,然后换行,输入个数大于1的-或者=,换行输出标题,并且带有满行的下划线 注意:在开启了==key==显示高亮内容的设置,多个

1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这个坊间口碑,但是使用起来并不舒心-原因如下: 笨重,每次打开md文档都需要等待软件启动 无法预览效果,需要安装额外的软件Awesomium 打开文档,预览显示一片空白也是常事 2. Notepad++ 免费 轻量 插件众多 台湾同胞开发 支持众多语言风格的展示(可以集成编辑各类文档) 3. 搭建编写

目录 1. 原理 2. 运行方法 3. 效果 4. 代码 1. 原理 正则匹配对相应字符串进行替换 2. 运行方法 python md_convert.py [a.md, b.md,...] # 转换给定文档 或 python md_convert.py # 转换目录下所有的md文档 3. 效果 4. 代码 #coding:utf-8 """ ---------------------------------------- description: md文档格式化处理类 为m

简介 在日常写readme文档中,可能会遇到一些小问题,此处记录一下md文档编写过程中的一些小技巧. 插入图片 在md文档中插入图片,目前有三种方式,本地导入.网络导入.base64导入. 本地导入 非常依赖与本地,无法脱机显示,不建议使用  网络导入 需要事先将图片上传到网络并生成一个链接,在编写时较为简易方便  base64导入 需要事先将对应图片转换成base64编码,再插入到对应位置即可,

1. git错误提示 $ hexo g INFO Start processing FATAL Something's wrong. Maybe you can find the solution here: http://hexo.io/docs/troubleshooting.html Template render error: (unknown path) [Line , Column ] unexpected token: }} 2. 解决办法 2.1 Template render

markdown语法 官网 这是标题 "#加空格" 是标题,通常可以设置六级标题. 内容下 空格是换行 列表 无序列表:使用" - + * "任何一种加空格都可以 列表内容 列表内容 列表内容 有序列表:数字加点加空格 有序1 有序2 有序3 列表嵌套上一级和下一级之间敲三个空格 - 一级无序列表 123- 二级无序列表 - 二级无序列表 - 二级无序列表 一级无序列表 二级无序列表 二级无序列表 二级无序列表 字体部分 要加粗的字体:用两个"**&quo

大标题 =================================== 大标题一般显示工程名,类似html的\<h1\> 你只要在标题下面跟上=====即可 中标题 ----------------------------------- 中标题一般显示重点项,类似html的\<h2\><br/> 你只要在标题下面输入------即可 ### 小标题 小标题类似html的\<h3\><br/> 小标题的格式如下 ### 小标题<br/

前言 通常我们认为每个测试用例都是相互独立的,因此需要保证测试结果不依赖于测试顺序,以不同的顺序运行测试用例,可以得到相同的结果. pytest默认运行用例的顺序是按模块和用例命名的 ASCII 编码顺序执行的,这就意味着每次运行用例的顺序都是一样的. app 测试里面有个 monkey 测试,随机在页面点点点,不按常理的点点点能找到更多的不稳定性 bug.那么我们在写pytest用例的时候,既然每个用例都是相互独立的, 那就可以打乱用例的顺序随机执行,用到 pytest 的插件 pytest-

简介 安装 我的配置 Chocolatey 简介 - Windows的包管理器 官方网址 安装 注意事项 Python 简介 安装 Pip 简介-Python的包管理器 升级 MkDocs的安装 使用Pip安装MkDocs 检查是否安装正确 MkDocs的使用 初步试用根据官方文档的步骤创建和使用MkDocs 常用命令 My Test 注意事项 简介 类别:项目文档生成器,生成静态站点,管理MarkDown文档. 官方网址:http://www.mkdocs.org/ 中文文档:http://m

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

为啥要用docsify? 神器Docsify让你的文档变得美观,配合typora,从此爱上看文档,各种优点:小巧.快速.美观.方便.快捷.上手快,可以浏览如下优秀案例 ve-charts pyecharts pyecharts-gallery 处于萌芽阶段的 Java 核心知识库 更多案例请看:Awesome Docsify 安装 1.首先安装npm: sudo apt install npm 如果报错,则执行如下命令安装相关依赖 sudo apt-get install nodejs-dev

目录 1.什么是Gitlab Pages 2.开启Gitlab Pages 3.基本过程 4.托管markdown文档 4.1 安装sphinx等依赖 4.2 配置项目的sphinx配置 4.3 编写项目文档 4.4 创建首页索引 4.5 配置gitlab-ci.yml 4.6 生成网页 4.7 配置DNS或者hosts文件 5.预览和调试 5.1 直接使用sphinx命令生成网页 5.2 VScode+sphinx插件预览 5.3 下载Gitlab生成的网页 总结 这段时间准备软考去了,也挺久

和PDF一样,在word中,水印也分为图片水印和文本水印,给文档添加图片水印可以使文档变得更为美观,更具有吸引力.文本水印则可以保护文档,提醒别人该文档是受版权保护的,不能随意抄袭.前面我分享了如何给PDF添加水印,有人问我如何给word文档添加水印,今天正好有空,就记录一下我是如何实现的. 步骤其实很简单,为了节省时间和简化代码规模,我从E-iceblue官网上下载了一个免费word组件,解压安装之后,参考官网的教程,创建项目,并按步骤对代码进行了简单的设置.下面就来看看如何通过这个组件实现上

让前端程序更具可维护性,是一个老生常谈的问题,大多数时候我们都关注于应用层面的代码可维护性,如:OO.模块化.MVC,编码规范.可扩展和复用性,但这都是属于设计层面需要考虑的事情,可维护性还应包含另一个方面,也是很多coder容易忽略的地方,就是将自己写的程序以文档的形式沉淀起来,对自己工作有一个结构化的组织,也可以帮助到他人. 试想一下如下情况:1.团队中加入了新的同学,这时他可能需要快速的将目前项目中现有程序有一个系统的了解,如:某个公共工具模块的用途,某个通用组件的接口,程序之间的依赖性,

最近做ios framework的一些测试,提供给其他开发者使用的framework,API文档变得更加重要,以前没有接触过,这次尝试使用了一把appledoc来生成一下文档,感觉还不错. 首先,是从这个哥们儿的文章里面发现大家推荐使用appledoc http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/ 下面介绍一下appledoc的基本使用. 1 — 安装 git clone git://git

前言 公司一直采用Word文档方式与客户端进行交流.随着时间的推移,接口变的越来越多,文档变得也很繁重.而且一份文档经常由多个开发人员维护,很难保证文档的完整性.而且有时写完代码也忘了去更新文档,为了这些小事经常受客户端同事鄙视. 于是带着问题去查找解决方案,在网上一通乱搜后查找出以下两个工具:AspNet.WebApi.HelpPage,Swagger. 细细比较最终选择 Swagger ,因为优点实在太多,具体可网上自行搜索,在这里就不在赘述. 实现 1.引用NuGet包        2.

随着前后端的分离,借口文档变的尤其重要,springfox是通过注解的形式自动生成API文档,利用它,可以很方便的书写restful API,swagger主要用于展示springfox生成的API文档. 官网地址:http://springfox.github.io/springfox/ Springfox大致原理 springfox的大致原理就是,在项目启动的过种中,spring上下文在初始化的过程,框架自动跟据配置加载一些swagger相关的bean到当前的上下文中,并自动扫描系统中可能需

大部分 Web 应用程序都支持 RESTful API,但不同于 SOAP API——REST API 依赖于 HTTP 方法,缺少与 Web 服务描述语言(Web Services Description Language,WSDL)类似的语言来定义使用者与提供者之间的请求和响应结构.由于没有充分的合同服务,许多 REST API 提供者使用 Microsoft Word 文档或维基页面来记录 API 用法.这些格式使协作和文档版本控制变得很困难,尤其对于有许多 API 或资源的应用程序,或者