Preview Elm package and application documentation offline with hot reloading, matching the official package website.
elm-doc-preview is a command-line tool that allows Elm developers to preview documentation for their packages and applications offline. It renders documentation identically to the official Elm package website, ensuring consistency and helping catch issues before publishing. The tool supports hot reloading, serves cached package docs, and can generate documentation for applications via a configuration file.
Elm developers who are creating packages or applications and need to preview and verify their documentation locally before release. It's particularly useful for those working offline or in environments without reliable internet access.
Developers choose elm-doc-preview because it provides an accurate, offline-compatible preview that matches the official Elm package site, reducing release risks. Its hot reloading and support for both packages and applications streamline the documentation workflow.
Elm offline documentation previewer
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Renders documentation exactly like the Elm package website, ensuring consistency and avoiding surprises during package releases, as stated in the README's aim.
Provides live documentation hot reloading for both packages and applications, improving developer workflow efficiency, as highlighted in the features list.
Serves documentation for all locally cached Elm packages without an internet connection, making it ideal for offline development environments.
Generates documentation for Elm applications, which Elm doesn't natively support, by creating a package from the application with configurable options via elm-application.json.
Requires creating an elm-application.json file with exposed modules for applications, adding setup complexity that isn't required for standard Elm packages.
Ports are stubbed with fake versions and must be declared on one line, which can be restrictive and cause issues for applications with complex port definitions.
The README explicitly states it's a development tool with no security measures, making it unsuitable for public hosting and limiting deployment options.
Does not support generating static web pages for documentation; users must rely on other tools like ento/elm-doc for static hosting, as noted in the FAQ.