Make a docSet document for Dash on a Mac

Dash is a tool for viewing API on mac, which can directly download most of the API documents, but sometimes if we want to integrate the existing documents in our hands into Dash, we need to do it ourselves. In fact, Dash official also has a tutorial on how to make a docSet. The address is: http://kapeli.com/docsets ( 7. Any HTML Documentation ) .


The documents required by Dash are docSet files. In fact, the docSet file is just a folder. This folder contains the final html documents and the indexes built based on these html (the indexes are placed in the sqlite database), which is very simple.


Below I will take the official Chinese document (html) of mysql5.1 as an example to explain how to create a docSet step by step according to the html document

1. Download the html Chinese document of 5.1 from the official website of mysql. The download address is: http://downloads.mysql.com/docs/refman-5.1-zh.html-chapter.zip. After downloading and decompressing, you will find that there are some html files in it, and there are 2 of them that need attention. One is index.html and the other is ix01.html. It is necessary to index the contents of these two files in the format required by dash.

2. Create a folder. In this example, the document we created is called mysql51

Guess you like

Origin blog.csdn.net/bokix/article/details/37932919