###########
 Serialize
###########

.. currentmodule:: turbohtml

Turn a tree back into markup or text. Each renderer takes one configuration object: :meth:`Node.serialize` and
:meth:`Node.encode` produce HTML under an :class:`Html` config (a :class:`Formatter` picks the escape policy, an
:class:`Indent` or :class:`Minify` picks the whitespace, and ``xml=True`` switches to XML/XHTML syntax), and
:meth:`Node.serialize_iter` streams the same HTML in bounded ``str`` chunks for a large page (every layout but
:class:`Minify`, which needs the whole tree); :meth:`Node.to_markdown` takes a :class:`Markdown` config; and
:meth:`Node.to_text` and :meth:`Node.to_annotated_text` take a :class:`PlainText` config; and :meth:`Node.canonicalize`
produces Canonical XML (c14n) bytes under a :class:`Canonical` config. :meth:`Node.to_source` takes no config: it
losslessly re-emits the verbatim source of everything a mutation left untouched (parse with ``source_locations=True``),
the tree-based counterpart to :func:`turbohtml.rewrite.rewrite`. :func:`escape` and :func:`unescape` are the standalone
string helpers; :func:`annotation_surface` and :func:`annotation_tags` post-process the annotated-text result. A
:class:`~turbohtml.clean.JSMinify` passed to :class:`Minify` extends HTML minification into inline ``<script>`` content;
the standalone :func:`~turbohtml.clean.minify_js` lives with the other minifiers in :mod:`turbohtml.clean`.

.. autofunction:: escape

.. autofunction:: unescape

.. autoclass:: Html
    :members:

.. autoclass:: Formatter
    :members:

.. autoclass:: Indent
    :members:

.. autoclass:: Minify
    :members:

.. autoclass:: Markdown
    :members:

.. autoclass:: PlainText
    :members:

.. autoclass:: Canonical
    :members:

.. autofunction:: annotation_surface

.. autofunction:: annotation_tags

********************************
 turbohtml.migration.markupsafe
********************************

.. module:: turbohtml.migration.markupsafe

A safe-string for composing HTML, a drop-in for `markupsafe <https://markupsafe.palletsprojects.com>`_'s public surface.
Import it in place of ``markupsafe``. ``Markup`` overrides every ``str`` method that returns text so the result stays a
``Markup``; the methods below are the turbohtml-specific ones, the rest mirror :class:`str`.

.. autofunction:: escape

.. autofunction:: escape_silent

.. autofunction:: soft_str

.. autoclass:: Markup
    :members: escape, format, join, striptags, unescape

.. autoclass:: EscapeFormatter
    :members: format_field