Dash

Dash 是 Mac 的一个文档管理工具，从它第一版发布用到现在，绝对是一个你值得拥有的文档管理工具。

Dash

特性

  • 支持任何一个你想管理的文档（iOS/Mac/PHP/Python/Java/jQuery/Backbone.js 等等）
  • 支持自定义生成你想要的文档（AppleDoc/JavaDoc/RDoc/Doxygen/pydoctor/Sphinx/Scaladoc）
  • 自动升级文档版本
  • 快捷键搜索文档及 API
  • 管理和搜索 Code Snippets
  • 无缝插入众多第三方应用（Alfred，XCode，Terminal，Eclipse，甚至任意的 App）

Dash Feature

功能介绍

这块已经有人介绍了，我就不多说了：Dash：程序员的的好帮手

生成自己的文档

Dash 本身只支持 docsets 格式的文档，也就是由 appledoc 生成的。默认是让 XCode 的 Organizer 管理文档，但是针对这个庞然大物，只是做文档的管理和快速搜索有消受不起。因此 Dash 才诞生出来的。

其实本篇日志主要是讲这块的内容，从上面的特性上面我也说到 Dash 支持生成任何的文档，因为它支持的文档类型涵盖了目前绝大多数的文档格式，针对这块官方已经写了如何转换的说明，这里简单说明下：

语言转换工具

Objective-Cappledoc 文档 Objective-C 文档

Python, Sphinx, doc2dashpydoctor

Javadoc
java.docset

RDoc
使用 Dash 自身的 “Ruby Installed Gems”

Scaladoc
mkscaldocset

Doxygen(源码)
修改参数生成

docsetutil
需要创建指定目录结构

SQLite
官方支持数据库索引，需要创建指定目录结构

生成 Flask 文档

因为最近在学习 Flask，过年回家家里没有网络，因为我需要可以查询它的文档，虽然官方提供了 html 和 pdf 格式，但是没有办法快速搜索 API，没法发挥 Dash 的优势嘛，对吧！

Flask 官方提供的 html 文档是 Sphinx 格式的，首先把文档下载到本地，并安装好 doc2dash，另外备好一个 flask icon。

  1. $ pip install doc2dash

因为 Dash 可以让每个文档都有自己的 Icon，否则默认只是 docset 的 Icon，下载完毕之后，执行代码：

  1. $ doc2dash --name Flask --icon flask-logo.png --add-to-dash /path/to/flask-docs

其中 --add-to-dash 是生成完毕后自动添加到 Dash，默认生成好的 docset 文件在当前目录。

好了，Dash 已经可以索引到所有的 Flask API 了，真是太 TMD 的酷了！

维护你的文档

如果你希望把自己生成的文档分享出来，并提供后期的维护升级，你可以提供一个 feed 保持文档的自动更新，这里有一个关于 NodeJS 的例子。

  • 你可以提供多个 url 多备份提供文档下载
  • 支持 tgz 格式的打包