zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-11-26 07:37:15 +03:00
Code Issues Projects Releases Wiki Activity

Documented docsets formats in README

Browse Source
This commit is contained in:
Jerzy Kozera 2013-02-10 20:00:17 +01:00
parent 1ef3c77fb6
commit b4fe3045fb
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -45,6 +45,15 @@ A 64-bit Windows binary with all dependencies is available to download from Drop
* More docsets
* Refactoring to reuse common code between `ZealDocsetsRegistry` and `ZealListModel`
## Creating your own docsets
For creating new docsets, you have three choices of index format supported by Zeal.
1. `ZEAL` format, as generated by scripts in `gendocsets` directory. It's essentially a single sqlite table with `type`, `name`, `path` and `parent` columns.
2. `DASH` format, which is also similar single table, without the `parent` column.
3. So-called `ZDASH`, which is a more complex Xcode docset format, implemented in Zeal to allow reusing Dash's docsets.
Author of Dash [has suggested](https://github.com/jkozera/zeal/issues/1#issuecomment-13357189) a "docset exchange programme", allowing Zeal to use one Dash docset in return for each new generated-for-Zeal docset, so it's recommended to use the `DASH` format.
## Contributions