package dream-serve

  1. Overview
  2. Docs
Static HTML website server with live reload

Install

Dune Dependency

Authors

Maintainers

Sources

1.0.1.tar.gz
md5=35c356143b82907a8e2afefe51cb29f1

Description

dream-serve serves a static HTML site. It injects a small script which reloads Web pages when they are updated in the file system. This makes it great for static site development, including odoc documentation pages, and for viewing Bisect_ppx coverage reports across multiple test runs.

Published: 15 May 2023

README

dream-serve

dream-serve is a very simple server for static sites. It reloads your browser when the site changes.



It's good for developing docs, streamlining coverage reports, and so forth. It works by injecting a script into HTML, which opens a WebSocket back to the server. The server uses the WebSocket to tell the browser when to reload.


Usage

opam install dream-serve
dream-serve ./my/site

To choose a port number,

dream-serve ./my/site -p 9090

Based on

dream-serve is implemented as one small OCaml file. It is based on Web framework Dream, libuv binding Luv, and HTML rewriter Lambda Soup.

Special thanks to Ulrik Strid for writing the integration between Lwt and Luv/libuv that makes it possible to easily run Dream over libuv.

Dependencies (6)

  1. lwt_ppx
  2. lwt >= "5.4.0"
  3. luv
  4. lambdasoup >= "0.6.1"
  5. dune >= "2.0.0"
  6. dream >= "1.0.0~alpha3"

Dev Dependencies

None

Used by

None

Conflicts

None