Skip to content

Commit

Permalink
Staticmod doc update + menu
Browse files Browse the repository at this point in the history
  • Loading branch information
balat committed Jun 15, 2024
1 parent 66c5b8e commit 682f0c9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
15 changes: 14 additions & 1 deletion doc/dev/api/menu.wiki
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
=~Ocsigen server ~- ~A~P~I reference
==Extensions
===[[Staticmod|Staticmod]]
===[[Extendconfiguration|Extendconfiguration]]
===[[Accesscontrol|Accesscontrol]]
===[[Authbasic|Authbasic]]
===[[CGImod|CGImod]]
===[[Deflatemod|Deflatemod]]
===[[Redirectmod|Redirectmod]]
===[[Revproxy|Revproxy]]
===[[Rewritemod|Rewritemod]]
===[[Outputfilter|Outputfilter]]
===[[Userconf|Userconf]]
===[[Comet|Comet]]
===[[CORS|CORS]]
==~Persistent data~, writing in the logs~, configuration file extension~, polymorphic tables
===[[Ocsigen_lib|Ocsigen_lib]]
===[[Ocsigen_messages|Ocsigen_messages]]
Expand All @@ -17,7 +31,6 @@
===[[Ocsigen_http_com|Ocsigen_http_com]]
===[[Ocsigen_stream|Ocsigen_stream]]
===[[Ocsigen_comet|Ocsigen_comet]]
===[[Authbasic|Authbasic]]
==~Indexes
=== <<a_api text="Index of types" | index types >>
=== <<a_api text="Index of exceptions" | index exceptions >>
Expand Down
2 changes: 1 addition & 1 deletion doc/dev/manual/quickstart.wiki
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,4 @@ default).
If you cannot solve your problem, if you find a bug,
a mistake in the documentation (even a small one),
or if you want to make a suggestion,
[[https://github.com/ocsigen/ocsigenserver|fill a ticket on Github]].
[[https://github.com/ocsigen/ocsigenserver|open an issue on Github]].
10 changes: 8 additions & 2 deletions doc/dev/manual/staticmod.wiki
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
=Staticmod=
Staticmod is a module allowing to serve static pages (files).
==Configuration

==Using as a library
Have a look at the <<a_api text="API documentation"|module Staticmod>>
if you want to use Staticmod as a library for your OCaml programs.

==Configuration file
===Basics

To use that extension, first load it from the configuration file:
To use that extension with Ocsigen Server's configuration file,
load the extension like this:
{{{
<extension findlib-package="ocsigenserver.ext.staticmod"/>
}}}
Expand Down

0 comments on commit 682f0c9

Please sign in to comment.