umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00
Code Issues Wiki Activity

Fix examples in cowboy_static edoc and guide

Browse source
This commit is contained in:
Adam Cammack 2013-02-10 00:03:30 -06:00
parent 65ed13d2da
commit 6575ceb0dd
2 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
guide/static_handlers.md
View file

@ -21,7 +21,7 @@ mimetypes library to figure out the files' content types.
``` erlang ``` erlang
Dispatch = [ Dispatch = [
{'_', [ {'_', [
{['...'], cowboy_static, [ {"/[...]", cowboy_static, [
{directory, {priv_dir, static, []}}, {directory, {priv_dir, static, []}},
{mimetypes, {fun mimetypes:path_to_mimes/2, default}} {mimetypes, {fun mimetypes:path_to_mimes/2, default}}
]} ]}

22
src/cowboy_static.erl
View file

@ -44,15 +44,15 @@
%% ==== Examples ==== %% ==== Examples ====
%% ``` %% ```
%% %% Serve files from /var/www/ under http://example.com/static/ %% %% Serve files from /var/www/ under http://example.com/static/
%% {[<<"static">>, '...'], cowboy_static, %% {"/static/[...]", cowboy_static,
%% [{directory, "/var/www"}]} %% [{directory, "/var/www"}]}
%% %%
%% %% Serve files from the current working directory under http://example.com/static/ %% %% Serve files from the current working directory under http://example.com/static/
%% {[<<"static">>, '...'], cowboy_static, %% {"/static/[...]", cowboy_static,
%% [{directory, <<"./">>}]} %% [{directory, <<"./">>}]}
%% %%
%% %% Serve files from cowboy/priv/www under http://example.com/ %% %% Serve files from cowboy/priv/www under http://example.com/
%% {['...'], cowboy_static, %% {"/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, [<<"www">>]}}]} %% [{directory, {priv_dir, cowboy, [<<"www">>]}}]}
%% ''' %% '''
%% %%
@ -74,14 +74,14 @@
%% ==== Example ==== %% ==== Example ====
%% ``` %% ```
%% %% Use a static list of content types. %% %% Use a static list of content types.
%% {[<<"static">>, '...'], cowboy_static, %% {"/static/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, []}}, %% [{directory, {priv_dir, cowboy, []}},
%% {mimetypes, [ %% {mimetypes, [
%% {<<".css">>, [<<"text/css">>]}, %% {<<".css">>, [<<"text/css">>]},
%% {<<".js">>, [<<"application/javascript">>]}]}]} %% {<<".js">>, [<<"application/javascript">>]}]}]}
%% %%
%% %% Use the default database in the mimetypes application. %% %% Use the default database in the mimetypes application.
%% {[<<"static">>, '...'], cowboy_static, %% {"/static/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, []}}, %% [{directory, {priv_dir, cowboy, []}},
%% {mimetypes, {fun mimetypes:path_to_mimes/2, default}}]} %% {mimetypes, {fun mimetypes:path_to_mimes/2, default}}]}
%% ''' %% '''
@ -110,17 +110,17 @@
%% ==== Examples ==== %% ==== Examples ====
%% ``` %% ```
%% %% A value of default is equal to not specifying the option. %% %% A value of default is equal to not specifying the option.
%% {[<<"static">>, '...'], cowboy_static, %% {"static/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, []}}, %% [{directory, {priv_dir, cowboy, []}},
%% {etag, default}]} %% {etag, default}]}
%% %%
%% %% Use all avaliable ETag function arguments to generate a header value. %% %% Use all avaliable ETag function arguments to generate a header value.
%% {[<<"static">>, '...'], cowboy_static, %% {"static/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, []}}, %% [{directory, {priv_dir, cowboy, []}},
%% {etag, {attributes, [filepath, filesize, inode, mtime]}}]} %% {etag, {attributes, [filepath, filesize, inode, mtime]}}]}
%% %%
%% %% Use a user defined function to generate a strong ETag header value. %% %% Use a user defined function to generate a strong ETag header value.
%% {[<<"static">>, '...'], cowboy_static, %% {"static/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, []}}, %% [{directory, {priv_dir, cowboy, []}},
%% {etag, {fun generate_strong_etag/2, strong_etag_extra}}]} %% {etag, {fun generate_strong_etag/2, strong_etag_extra}}]}
%% %%
@ -153,17 +153,17 @@
%% %%
%% ``` %% ```
%% %% Serve cowboy/priv/www/index.html as http://example.com/ %% %% Serve cowboy/priv/www/index.html as http://example.com/
%% {[], cowboy_static, %% {"/", cowboy_static,
%% [{directory, {priv_dir, cowboy, [<<"www">>]}} %% [{directory, {priv_dir, cowboy, [<<"www">>]}}
%% {file, <<"index.html">>}]} %% {file, <<"index.html">>}]}
%% %%
%% %% Serve cowboy/priv/www/page.html under http://example.com/*/page %% %% Serve cowboy/priv/www/page.html under http://example.com/*/page
%% {['_', <<"page">>], cowboy_static, %% {"/:_/page", cowboy_static,
%% [{directory, {priv_dir, cowboy, [<<"www">>]}} %% [{directory, {priv_dir, cowboy, [<<"www">>]}}
%% {file, <<"page.html">>}]}. %% {file, <<"page.html">>}]}.
%% %%
%% %% Always serve cowboy/priv/www/other.html under http://example.com/other %% %% Always serve cowboy/priv/www/other.html under http://example.com/other
%% {[<<"other">>, '...'], cowboy_static, %% {"/other/[...]", cowboy_static,
%% [{directory, {priv_dir, cowboy, [<<"www">>]}} %% [{directory, {priv_dir, cowboy, [<<"www">>]}}
%% {file, "other.html"}]} %% {file, "other.html"}]}
%% ''' %% '''