https://github.com/pdamoc/elm-docset

Elm Docset generator
https://github.com/pdamoc/elm-docset

docset documentation elm

Last synced: 11 months ago
JSON representation

Elm Docset generator

• Host: GitHub
• URL: https://github.com/pdamoc/elm-docset
• Owner: pdamoc
• License: mit
• Created: 2015-09-15T18:03:39.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-05-22T21:33:41.000Z (about 3 years ago)
• Last Synced: 2025-04-22T11:33:38.077Z (about 1 year ago)
• Topics: docset, documentation, elm
• Language: Python
• Size: 59.6 KB
• Stars: 36
• Watchers: 2
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# elm-docset

Elm Dash Docset generator

To generate, execute `generate.py`. 

Requirements: `pybars3`, `markdown` and `requests`.

You can download the latest version of the docset from User Contributed Section in Dash's Preferences pane. 

To package, execute  `pack.sh`.

## Using Docker

You can build docker image with python and requirements installed

```

docker build -t elm-docset .

```

and then run the script

```

docker run -it --rm --name elm-docset -v "$PWD":/usr/src/app elm-docset python generate.py

```

You can also run packaging script within docker if you would like

```

docker run -it --rm --name elm-docset -v "$PWD":/usr/src/app elm-docset pack.sh 

```