On This Page
package asai
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
The definition of highlighted text suitable for rendering. You probably do not need this module unless you want to create your own backend.
Types
type 'style segment = (string, 'style) styledA segment is a styled string from the user content.
type 'style block = {start_line_num : int;(*The starting 1-indexed line number of a block.
*)lines : 'style line list;
}A block is a collection of consecutive lines.
type 'style part = {file_path : string;(*The file path of a part.
*)blocks : 'style block list;(*The blocks within a part.
*)
}A part consists of multiple blocks from the same file. These blocks should be non-overlapping and sorted by importance or the textual order.
type 'style t = 'style part listHighlighted texts instead of spans.
Helper Functions
val style : 'style -> 'value -> ('value, 'style) styledDebugging
val dump :
(Stdlib.Format.formatter -> 'style -> unit) ->
Stdlib.Format.formatter ->
'style t ->
unitUgly printer for debugging
On This Page