hello people, I would like to get a local/cached version of the documentation (ideally in a pure text or troff format). i really don’t know the elm ecosystem at all but i imagine there is no such thing available. if there isn’t, is there a way to query https://package.elm-lang.org/ with a rest API…

Hi @eiro , all packages that you’ve already installed live somewhere in ~/.elm and thanks to this, tools like dmy/elm-doc-preview are able to retrieve their documentation for local usage. Once installed, you can try the command elm-doc-preview from anywhere and it should open a web page served by a …

hello Matthieu, dmy/elm-doc-preview are able to retrieve their documentation for local usage. even if it’s not what i expected in term of ui, this is a real improvement to me. thanks! marc

Or you can use Dash or Zeal and download Elm docset. I’m trying to keep it updated on the newest version on monthly basis. If you would like to dig deeper, you can take a look at the python script I’m using to generate the docset and bend it to your needs :wink:

Where can I download the Elm docset for Zeal?

I don’t use Zeal, so I can’t tell you that for sure - but you should be able to do it like this: You can do this using Edit > Options > Docsets > Download. It is a User Contributed docset, so maybe it will be somewhere deeper than on the main page, hard to tell. Let me know if you have found it an…

There is only one place in Zeal for downloading docsets and Elm is not listed there. “User Contributed” docsets is not mentioned anywhere.

OK, this should help: Show Dash user contrib docsets in Zeal opened 08:46PM - 30 Jun 14 UTC (UTC) [jboadas] jboadas Just trying to see the user contrib docsets but …

So the address you are looking for is probably this one: http://newyork.kapeli.com/feeds/zzz/user_contributed/build/Elm/Elm.tgz

Or even better, I have found this app with the link to the XML feed: [image] Zeal User Contributions & Cheat Sheets

The “Feed URL (.xml)” there worked: Tools > Docsets > Installed > Add feed Feed URL: https://zealusercontributions.now.sh/api/docsets/Elm.xml EDIT: The URL must be “Feed URL (.xml)” and not “Feed URL”. Both will add the docset, but without .xml in URL it will be saved as .docset instead of El…

Local access to elm documentation?

Learn

kraklin October 5, 2020, 2:16pm 12

Cool, enjoy your offline docs then

Topic		Replies	Views
Dash docset for Elm now uses the packages.elm-lang.org styling Show and Tell	11	2282	February 21, 2020
Elm-doc-preview: A new online documentation previewer Show and Tell	4	2453	September 20, 2018
Elm-doc-preview update: hot reloading & previews sharing Show and Tell	1	945	December 14, 2018
Unnecessary files downloaded by elm install Learn	3	712	June 16, 2020
Elm-help, a tool to read packages docs from the command line Show and Tell	3	1034	January 26, 2018

Local access to elm documentation?

Related topics