aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_static.ezdoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 13:35:25 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 13:37:20 +0100
commit4023e7f4e429179fd9c2cce4487c33646c6bd327 (patch)
tree3c4e26d1b5592958e35297c82ad3069bdb642594 /doc/src/manual/cowboy_static.ezdoc
parentb7d666cfc746f55b0a72ef8d37f703885099daf7 (diff)
downloadcowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.gz
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.bz2
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.zip
Convert the documentation to Asciidoc
A few small revisions were made, and Erlang.mk has been updated.
Diffstat (limited to 'doc/src/manual/cowboy_static.ezdoc')
-rw-r--r--doc/src/manual/cowboy_static.ezdoc32
1 files changed, 0 insertions, 32 deletions
diff --git a/doc/src/manual/cowboy_static.ezdoc b/doc/src/manual/cowboy_static.ezdoc
deleted file mode 100644
index a827832..0000000
--- a/doc/src/manual/cowboy_static.ezdoc
+++ /dev/null
@@ -1,32 +0,0 @@
-::: cowboy_static
-
-The `cowboy_static` module implements file serving capabilities
-by using the REST semantics provided by `cowboy_rest`.
-
-:: Types
-
-: opts() = {priv_file, atom(), string() | binary()}
- | {priv_file, atom(), string() | binary(), extra()}
- | {file, string() | binary()}
- | {file, string() | binary(), extra()}
- | {priv_dir, atom(), string() | binary()}
- | {priv_dir, atom(), string() | binary(), extra()}
- | {dir, string() | binary()}
- | {dir, string() | binary(), extra()}
-
-Configuration for the static handler.
-
-The handler can be configured for sending either one file or
-a directory (including its subdirectories).
-
-Extra options allow you to define how the etag should be calculated
-and how the mimetype of files should be detected. They are defined
-as follow, but do note that these types are not exported, only the
-`opts/0` type is public.
-
-: extra() = [extra_etag() | extra_mimetypes()]
-
-: extra_etag() = {etag, module(), function()} | {etag, false}
-
-: extra_mimetypes() = {mimetypes, module(), function()}
- | {mimetypes, binary() | {binary(), binary(), [{binary(), binary()}]}}