介绍

作为一名程序员,工作中学习中免不了是要查询API文档的,毕竟我们能记住的东西有限,而且经常也会碰到某个API一时想不起来的情况,而每次还要打开网页去查询还是挺麻烦的,这时候拥有一个款好用的本地离线API文档大全就派上用场了,得益于Dash(mac),Zeal的文档非常丰富,截止2018.8.23已经有192个API文档了,官方地址:Zeal,拉到最下面可以看到支持的文档列表。

(PS:Zeal下载的文档是英文文档,还可以锻炼英文文档的阅读能力哦,貌似也是可以下载中文文档的离线文档包,但是我没有去探索)

下载文档

如何安装就不说了,打开安装包点下一步就行了,如何使用呢?Zeal安装完成后并不是直接可以用的,而是需要我们手动的去选择想要下载的API文档,当然选择下载文档之前你最好先选择一下文档的存放位置,Zeal的默认安装位置是C盘,文档存放地址也是,所以你需要在C盘之外的盘新建一个文件夹(你要放C盘的话也可以),然后在Zeal左上角选项Edit > prefrrences 点击打开如图面板,点击箭头处改为你想要存放的文件夹路径

接下来要下载文档了,点击左上角选项Tools > docsets 打开如下面板:

左边的选项卡是installed,是你已经下载的文档,右边的选项卡则是可以下载还未下载的文档,双击下载吧。稍微等候一会就会下载完成并出现在Zeal的主页面中左侧列表。

使用

使用也很方便,可以直接搜索你要的API,例如搜索slice,会将你已经下载的所有文档当中拥有这个API的都列出来,通过前面图标区分。

也可以使用JavaScript:slice这样限制只搜索JavaScript当中的slice API

一个坑

在折腾Zeal的时候遇到了一个问题,那就是明明在面板中点击下载了,但是已经下载的列表并没有显示该文档,在主页面也不能看到该文档,刷新列表之后又显示在未下载列表中。

当时我下载的是JavaScript包,这个包出问题让我很悲伤,后来又尝试了下载其他包都没有问题,打开文档存放的文件夹也的确已经下载好了,但是仍然不能显示。上网查找后也没有发现类似问题,也可能是因为我关键字不对。

经过一番查看后,发现Javascript包对比其他的包,在包的文档文件夹(每个文档都独立的放在一个xxx.docset的文件夹)contents文件夹下缺少了一个Info.plist文件,于是尝试着从CSS包当中复制了一个该文件副本到JavaScript.docsets/contents当中,打开后如下图,显然这个文件是有点类似配置文件的东东:

然后将图上箭头处的CSS都更改为JavaScript,并且将红色划线处更改为index.html(这里应该是文档在zeal当中显示首页的地址,是相对于JavaScript.docset\Contents\Resources\Documents的相对路径,而JavaScriot的index.html是直接在该路径下的,所以只写了index.html就行了)之后保存,打开Zeal,发现JavaScript出现了,并且可以正常使用!愉悦啊!可以开心的阅读文档了(:

Zeal——好用的离线 API 文档大全!的更多相关文章

  1. windows上zeal安装和使用--离线API文档

    1.官网:https://zealdocs.org/download.html#windows 2.github:https://github.com/zealdocs/zeal 3.下载:可下载安装 ...

  2. zeal工具的安装与使用(离线api文档浏览器)

    本来想下载一个dash来用一下,结果它只有mac版本,没有windows版,遂使用zeal zeal官网:https://zealdocs.org/ 文档地址:http://kapeli.com/do ...

  3. 很安逸的离线API文档查询工具Dash和Zeal

    大家开发的时候难免会查询一些文档,看一下API的调用方法等,所以会不同的语言去某一个地方去找,确实很麻烦,今天给大家安逸两款软件,肯定会让你爱不释手! Dash for macOS 官方地址:http ...

  4. Cocos2d-x精华教程汇总(第三期) cocos2d-x最新离线API文档下载(最新版3.6更新。。。)

    其实使用doxygen在Cocos2d-x引擎的doc目录下可以生成离线文档,但是可能每个人为了生成一个离线文档去安装甚至编译doxygen毕竟麻烦,而且现有的doxygen无法生成多语言版本的离线文 ...

  5. Spring Boot 2.X(十五):集成 Swagger2 开发 API 文档(在线+离线)

    前言 相信很多后端开发在项目中都会碰到要写 api 文档,不管是给前端.移动端等提供更好的对接,还是以后为了以后交接方便,都会要求写 api 文档. 而手写 api 文档的话有诸多痛点: 文档更新的时 ...

  6. Bullet的学习资源(用Doxygen生成API文档)

    Bullet 全称 Bullet Physics Library,是著名的开源物理引擎(可用于碰撞检测.刚体模拟.可变形体模拟),这里将bullet的学习资源整理一下,希望能帮助入门者少走弯路. 看下 ...

  7. Core Java 学习笔记——1.术语/环境配置/Eclipse汉化字体快捷键/API文档

    今天起开始学习Java,学习用书为Core Java.之前有过C的经验.准备把自己学习这一本书时的各种想法,不易理解的,重要的都记录下来.希望以后回顾起来能温故知新吧.也希望自己能够坚持把自己学习这本 ...

  8. Android API 文档 离线秒开方法

    http://blog.csdn.net/haifengzhilian/article/details/39898627 也是最近才看Android开发,但是,它的API文档无论是在线还是离线的,实在 ...

  9. JDK8 API离线文档免费下载&JavaEE API文档离线下载&API在线查看链接&常用的JAR包下载

    1.JDK8 API离线文档 链接:https://pan.baidu.com/s/1fYc-QesmYRumTEPmnSgEKA 提取码:2bdr 2.JavaEE API文档离线下载 链接:htt ...

随机推荐

  1. Golang 并发Groutine实例解读(二)

    go提供了sync包和channel机制来解决协程间的同步与通信. 一.sync.WaitGroup sync包中的WaitGroup实现了一个类似任务队列的结构,你可以向队列中加入任务,任务完成后就 ...

  2. Docker中“TERM environment variable not set.”问题

    在使用top查容器内部资源利用情况时候,发现无法使用,报“TERM environment variable not set.”错误.从网上找到了解决方案,经实验有效 root@103b5f05462 ...

  3. Deep Q-Network 学习笔记(五)—— 改进③:Prioritized Replay 算法

    也就是优先采样,这里的推导部分完全没看懂 Orz,这里也只是记录实现代码. 也就是看了以下两篇文章对应做了实现. 莫烦老师的教程: https://morvanzhou.github.io/tutor ...

  4. 神奇的datetime和datetime,一毫秒引发的血案

    今天才发现C#的datetime和sqlserver的daetime是多么的不一样.首先最小和最大值不一样这是众所周知的,其实精度也是一大坑. 比如 DateTime.Today.AddMillise ...

  5. 泛型通配符extends与super的区别

    <? extends T>限定参数类型的上界:参数类型必须是T或T的子类型 <? super T> 限定参数类型的下界:参数类型必须是T或T的超类型 总结为: <? ex ...

  6. [选译]MySQL5.7以上Zip版官方安装文档

    前言 在windows上安装Zip版MySQL(选译) 学习mysql的朋友们会发现5.7+版本的mysql变得比以前难安装了许多(当然我们可以选择installer版本,但是这样总感觉对学习mysq ...

  7. POJ3278(KB1-C 简单搜索)

    Catch That Cow Description Farmer John has been informed of the location of a fugitive cow and wants ...

  8. Linux常用指令大全

    2017-03-25   16:35:42 刚开始学习Linux,由于记忆力有限,把平时常用的Linux命令整理出来,以便随时查阅:  linux 基本命令    ls     (list 显示当前目 ...

  9. c语言中函数的形参test(int *&a)?

    今天在看一段c代码的时候看到一个函数的形参是(int *&a)居然是这个东西,这让我好生疑惑啊,不知道用这么多的地址符号用意何在呢?传址么? 那也不必这样,只需要用指针完全能够达到这样的效果啊 ...

  10. Spring Boot--01错误处理

    package com.smartmap.sample.ch1.controller.view; import java.io.IOException; import java.util.Collec ...