stog 0.20.0 · OCaml Package

stog

stog
- Stog
  - Blocks
    
    Smap
  - Config
  - Cut
  - Date
  - Deps
  - Doclist
  - Dyn
  - Engine
    
    Module
  - Error
  - Exec
  - Filter
  - Filter_lexer
  - Filter_parser
  - Filter_types
  - Find
  - Graph
    
    GMap
    
    Make
    
    Edge
    
    M
    
    Make_with_map
    
    Edge
    
    P
    
    S
  - Highlight
  - Html
  - Html5
  - Info
  - Init
  - Install
    
    Sites
  - Intl
  - Io
  - Latex
  - Log
  - Ocaml
  - Of_latex
    
    SMap
  - Path
    
    Map
    
    Set
  - Plug
  - Server_mode
  - Svg
  - Tags
  - Tmap
    
    S
  - Tmpl
  - Trie
    
    Make
    
    P
    
    S
  - Types
    
    Depset
    
    Doc_set
    
    Graph
    
    Int_map
    
    Int_set
    
    Path_trie
    
    Str_map
    
    Str_set
  - Url
  - Version
stog.base
- Stog_base
  - Misc
  - Ocaml_types
stog.main
- Stog_main
stog.ocaml_session_main
- Stog_ocaml_session_main

Legend:
Library
Module
Module type
Parameter
Class
Class type

Registering a server

val http_url : string ref

Default URL, modified by command line option

val ws_url : string ref

Default websocket URL, modified by command line option

val pub_http_url : string option ref

Optional public HTTP URL, modified by command line option

val pub_ws_url : string option ref

Optional public websocket URL, modified by command line option

type server_mode = [

| `Multi of string list -> unit
| `Single of (unit -> Types.stog) -> Types.stog -> unit

]

Multi server: handling users, sessions with editor and preview for each session.

Single: Simple preview server.

val server_mode : server_mode option ref

val set_single : 
  ((unit -> Types.stog) ->
    Types.stog ->
    http_url:Url.url_config ->
    ws_url:Url.url_config ->
    unit) ->
  unit

val set_multi : 
  (http_url:Url.url_config -> ws_url:Url.url_config -> string list -> unit) ->
  unit