Skip to content

Latest commit

 

History

History
30 lines (21 loc) · 1.09 KB

README.md

File metadata and controls

30 lines (21 loc) · 1.09 KB
Raw

leaflet-docset

Documentation for the Leaflet JavaScript map library in the Dash docset format, ready for offline reading and searching.

To Use Docs

  1. Install a docset viewer, like Dash.
  2. In Dash's preferences, search for this docset under the "user contributed" section:

image

  1. Press "download"

If you are using another docset viewer, like Zeal for Windows or Linux, you may need to download the docset file (Leaflet.tgz) from the latest release.

To Generate Docs

The docs are copied from the Leaflet site and indexed using a Ruby script. To set up and run the Ruby script:

   cd leaflet-docset
   bundle install
   rake

Future Improvements

[ ] The classification of sections (into class, method, interface, etc.) is fast and loose. It could use improvement.