/nim-docset

Docsets for Nim in Dash, Zeal or Velocity

Primary LanguageNimMIT LicenseMIT

Docsets for Nim in Dash, Zeal or Velocity

This project is using dashing - a docset generator to create Nim docset.
Docset is a file format of api documentations designed for offline browsing and optimized for querying.
You can use Dash(OS X),Zeal(Linux,Windows) or Velocity(Windows) to open it.

Install in reader

To install latest version into your docset reader, use this feed URL.

Download and extract

To install a versioned release that allows multiple versions to coexist, download from the Github releases page and extract to the docset directory configured in the reader.

Generating docs

Prerequisites

  • Ensure a working GCC, Nim, Go and NodeJS installations
  • make sure koch tool is in the nim directory and has the 'execute' permission
    • (nim installed with choosenim might require sudo chmod +x ~/.choosenim/toolchains/<nim-version>/koch)
  • Install dashing package go install github.com/technosophos/dashing
  • Clone this repo

Non-versioned docset

To create a docset ready to upload to Kapeli:

nim e docset.nims

This will create Nim.tgz in the current directory.

Versioned docset

To create a versioned docset found in the releases page:

nim e docset.nims --version

This will create nim-x.y.z.docset.zip in the current directory.

Target compiler

By default, docs will be generated for the Nim compiler that ran the script. If you need to point to another location, specify /path/to/nim/root as a parameter.

Credits

Thanks to the work from niv, wicast and genotrance.