.. _stdlib_md_boost:

===========================
Markdown generation helpers
===========================

.. das:module:: md_boost

The MD_BOOST module provides Markdown generation helpers: GitHub-flavored table
rendering with aligned columns and per-column alignment, plus small text utilities
(bold, cell-separator escaping). Numeric cell formatting is left to the caller (the
``"{x:.2f}"`` interpolation-format form); this module handles layout and alignment.

All functions and symbols are in "md_boost" module, use require to get access to it.

.. code-block:: das

    require daslib/md_boost



++++++++++++
Enumerations
++++++++++++

.. _enum-md_boost-ColAlign:

.. das:attribute:: ColAlign

enum ColAlign


++++++
Tables
++++++

  *  :ref:`render_md_table (headers: array\<string\>; aligns: array\<ColAlign\>; rows: array\<array\<string\>\>) : string <function-md_boost_render_md_table_array_ls_string_gr__array_ls_ColAlign_gr__array_ls_array_ls_string_gr__gr_>`

.. _function-md_boost_render_md_table_array_ls_string_gr__array_ls_ColAlign_gr__array_ls_array_ls_string_gr__gr_:

.. das:function:: render_md_table(headers: array<string>; aligns: array<ColAlign>; rows: array<array<string>>) : string

def render_md_table (headers: array<string>; aligns: array<ColAlign>; rows: array<array<string>>) : string

:Arguments: * **headers** : array<string>

            * **aligns** : array< :ref:`ColAlign <enum-md_boost-ColAlign>`>

            * **rows** : array<array<string>>


++++++++++++
Text helpers
++++++++++++

  *  :ref:`md_bold (s: string) : string <function-md_boost_md_bold_string>`
  *  :ref:`md_escape (s: string) : string <function-md_boost_md_escape_string>`

.. _function-md_boost_md_bold_string:

.. das:function:: md_bold(s: string) : string

def md_bold (s: string) : string

:Arguments: * **s** : string

.. _function-md_boost_md_escape_string:

.. das:function:: md_escape(s: string) : string

def md_escape (s: string) : string

:Arguments: * **s** : string