You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/odoc_for_authors.mld
+27Lines changed: 27 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -628,6 +628,33 @@ would render as
628
628
The light syntax has the advantages of being arguably more readable for small tables, when viewing the source file directly. However, its content is restricted (for instance, no new line is allowed).
629
629
The heavy syntax is easier to write, can be more readable for big tables, and supports having any kind of content inside. It does not support alignment (yet).
630
630
631
+
{2 Medias}
632
+
633
+
Odoc 3.0 introduced new markup for medias. Medias are nestable blocks,
634
+
so they can be put inside lists and tables, but they cannot be
635
+
inlined, for instance in a link..
636
+
637
+
There are currently three kinds of medias: image, audio, and
638
+
video. Each of them can refer to the file either using an asset
639
+
reference, or a direct link.
640
+
641
+
The markup is [{<media>:link}], [{<media>!ref}],
642
+
[{{<media>:link}Replacement text}] and [{{<media>:ref}Replacement text}],
643
+
where [<media>] is either [image], [video] or [audio].
644
+
645
+
The replacement text is used for backends that do not support medias
646
+
(latex and man), and for when a reference is unresolved. In the case
647
+
of an image, it is also used to generate an alternative text.
0 commit comments