aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/index.ezdoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2014-07-06 13:10:35 +0200
committerLoïc Hoguin <[email protected]>2014-07-06 13:10:35 +0200
commit078d686a0ac0aed212db97d73bd1e4a9387a4956 (patch)
tree6bbc6111fdbdfedd3bb351bf3b01c63fac0d7143 /doc/src/guide/index.ezdoc
parent1a71a733c37df70c15ebfd28157b10915cd738d1 (diff)
downloadcowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.gz
cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.tar.bz2
cowboy-078d686a0ac0aed212db97d73bd1e4a9387a4956.zip
Provide installable man pages
make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/.
Diffstat (limited to 'doc/src/guide/index.ezdoc')
-rw-r--r--doc/src/guide/index.ezdoc58
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/src/guide/index.ezdoc b/doc/src/guide/index.ezdoc
new file mode 100644
index 0000000..38b2ac0
--- /dev/null
+++ b/doc/src/guide/index.ezdoc
@@ -0,0 +1,58 @@
+::: Cowboy User Guide
+
+The Cowboy User Guide explores the modern Web and how to make
+best use of Cowboy for writing powerful web applications.
+
+:: Introducing Cowboy
+
+* ^"Introduction^introduction
+* ^"The modern Web^modern_web
+* ^"Erlang and the Web^erlang_web
+* ^"Erlang for beginners^erlang_beginners
+* ^"Getting started^getting_started
+
+:: HTTP
+
+* ^"The life of a request^http_req_life
+* ^"Routing^routing
+* ^"Handling plain HTTP requests^http_handlers
+* ^"The Req object^req
+* ^"Reading the request body^req_body
+* ^"Sending a response^resp
+* ^"Using cookies^cookies
+
+:: Multipart
+
+* ^"Introduction to multipart^multipart_intro
+* ^"Multipart requests^multipart_req
+
+:: Static files
+
+* ^"Static handler^static_handlers
+
+:: REST
+
+* ^"REST principles^rest_principles
+* ^"Handling REST requests^rest_handlers
+* ^"REST flowcharts^rest_flowcharts
+* ^"Designing a resource handler^resource_design
+
+:: Websocket
+
+* ^"The Websocket protocol^ws_protocol
+* ^"Handling Websocket connections^ws_handlers
+
+:: Server push
+
+* ^"Loop handlers^loop_handlers
+
+:: Pluggable interface
+
+* ^"Middlewares^middlewares
+* ^"Protocol upgrades^upgrade_protocol
+* ^"Hooks^hooks
+
+:: Internals
+
+* ^"Architecture^architecture
+* ^"Dealing with broken clients^broken_clients