This project is using dashing -- A docset gengrator,for Nim docset generating.
Docset is a kind of file designed for offline api documation browser which is optimized for querying.
You can use Dash(OS X),Zeal(Linux&Windoge:dog:) or Velocity(Windoge:dog:) to open it.
An official prebuilded document docset is also maintain by this project.
Download is in release,tested on Linux Zeal.
First of all,you shoud install dashing first.
There is a dashing.json file which can be used as configuration(remember to change you name and package feild) for dashing build command.
The souce html should be generated by nim doc or nim doc2.
The official html documents can be grab like this.
wget -r -p -k -np http://nim-lang.org/docs/theindex.html
The entry types of docset is limited,so I have to choose other name for Nim's unique concept like let,iterator
| nim | docset |
|---|---|
| let | Value |
| converter | Modifier |
| iterator | Provider |
| template | Shortcut |
Forgive my poor english :( ,I can't figure out another more accurate names.If you have batter ideas,open a new issue,plz.
- Manual and Api documation can't distinct by just using css selector.
- Batter Entry names.
- Icon needed.