Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

elm-doc-preview

Package Overview
Dependencies
Maintainers
1
Versions
29
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

elm-doc-preview

Elm packages documentation previewer with hot reloading.

  • 1.0.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.3K
increased by11.92%
Maintainers
1
Weekly downloads
 
Created
Source

elm-doc-preview

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).

Online version

There is an online version supporting documentation loading from github that can be used for reviews:

https://elm-doc-preview.netlify.com

Local version

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

Credits

  • Documentation rendering from package.elm-lang.org by Evan Czaplicki.
  • Markdown rendering from Marked.js by Christopher Jeffrey.
  • Code highlighting from highlight.js by Ivan Sagalaev.
  • Code highlighting theme from Solarized by Jeremy Hull.
  • CSS spinner from SpinKit by Tobias Ahlin.

Keywords

FAQs

Package last updated on 13 Dec 2018

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc