docserve

Crates.iodocserve
lib.rsdocserve
version0.1.4
created_at2023-07-30 16:12:32.43025+00
updated_at2025-05-17 23:19:38.366462+00
descriptionMinimally configurable static web server.
homepage
repositoryhttps://gitlab.com/iosvc/docserve
max_upload_size
id930082
size59,192
Guillaume Xavier Taillon (gxtaillon)

documentation

README

docserve

Minimally configurable static web server.

What

Serve static html files from the current directory locally, by default on port 3000, with millisecond response times as provided by actix-web.

Why

Other off the shelf one liner web server either did not provide the correct behavior for cargo-doc relative paths, or had unsatisfactory performance.

Typical workflow

cd mycrate
cargo doc
cd target/doc
docserve &
xdg-open http://localhost:3000/mycrate

Help

Minimally configurable static web server.

Usage: docserve [OPTIONS]

Options:
      --bind-addresses <BIND_ADDRESSES>
          CSV of addresses to expose the api on [env: DOCSERVE_BIND_ADDRESSES=] [default: 127.0.0.1:3000]
  -h, --help
          Print help
  -V, --version
          Print version
Commit count: 12

cargo fmt