servr (version 0.25)

httd: Serve static files under a directory

Description

If there is an index.html under this directory, it will be displayed; otherwise the list of files is displayed, with links on their names. After we run this function, we can go to http://localhost:port to browse the web pages either created from R or read from HTML files.

Usage

httd(dir = ".", ...)
httw(
  dir = ".",
  watch = ".",
  pattern = NULL,
  all_files = FALSE,
  filter = NULL,
  handler = NULL,
  ...
)

Arguments

dir

The root directory to serve.

...

server configurations passed to server_config()

watch

a directory under which httw() is to watch for changes; if it is a relative path, it is relative to the dir argument

pattern

a regular expression passed to list.files() to determine the files to watch

all_files

whether to watch all files including the hidden files

filter

a function to filter the file paths returned from list.files() (e.g., you can exclude certain files from the watch list)

handler

a function to be called every time any files are changed or added under the directory; its argument is a character vector of the filenames of the files modified or added

Details

httd() is a pure static server, and httw() is similar but watches for changes under the directory: if an HTML file is being viewed in the browser, and any files are modified under the directory, the HTML page will be automatically refreshed.

References

https://github.com/yihui/servr

Examples

if (FALSE) { # interactive()
servr::httd()
}