elm-doc-preview
Advanced tools
This is a documentation previewer for Elm packages (>= 0.19).
It allows previewing README.md and docs.json files (generated with elm make --docs=docs.json).
It aims at rendering exactly like the official package website.
There is an online version supporting documentation loading from github that can be used for reviews:
https://elm-doc-preview.netlify.com
There is also a local version that supports hot reloading for convenient packages documentation editing:
$ npm install -g elm-doc-preview
Then, from the directory where your package elm.json is:
$ elm-doc-preview
or from anywhere:
$ elm-doc-preview path/to/package
As a side effect, this also allows to view installed packages documentation offline from the local cache:
$ elm-doc-preview ~/.elm/0.19.0/package/elm/html/1.0.0/
FAQs
Elm offline documentation previewer with hot reloading.
The npm package elm-doc-preview receives a total of 2,280 weekly downloads. As such, elm-doc-preview popularity was classified as popular.
We found that elm-doc-preview demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.