Skip to content

Commit e512b47

Browse files
committed
Update lazy documentation
1 parent 8d1f520 commit e512b47

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

output/lazy.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,40 @@ forward references are unlikely to work, and backward references will
4747
work only if the target expression has already been typeset. We hope
4848
to improve this situation in a future release.
4949

50+
51+
.. _lazy-options:
52+
53+
Lazy Typesetting Options
54+
------------------------
55+
56+
Adding the `ui/lazy` extension to the `loader.load` array adds the
57+
following options to the MathJax configuration:
58+
59+
.. code-block:: javascript
60+
61+
MathJax = {
62+
options: {
63+
lazyMargin: '200px',
64+
lazyAlwaysTypeset: null
65+
}
66+
};
67+
68+
.. _lazy-lazyMargin:
69+
.. describe:: lazyMargin: '200px'
70+
71+
This gives the extent of the typesetting margin outside the visible
72+
viewport. When mathematics appears within this range of the
73+
viewport, it will be typeset. This allows typesetting to occur
74+
slightly before the math appears in the window, for a smoother
75+
effect.
76+
77+
.. _lazy-lazyAlwaysTypeset:
78+
.. describe:: lazyAlwaysTypeset: null
79+
80+
This gives an array of containers whose math expressions should
81+
always be typset during the initial typesetting pass, rather than
82+
waiting for them to scroll into view. This may be useful if
83+
MathJax output appears in diagrams or other layout that must be
84+
sized and placed during initial page layout.
85+
5086
|-----|

0 commit comments

Comments
 (0)