:py:mod:`myst_parser.slugs`
===========================

.. py:module:: myst_parser.slugs

.. autodoc2-docstring:: myst_parser.slugs
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`github_slugify <myst_parser.slugs.github_slugify>`
     - .. autodoc2-docstring:: myst_parser.slugs.github_slugify
          :summary:
   * - :py:obj:`gitlab_slugify <myst_parser.slugs.gitlab_slugify>`
     - .. autodoc2-docstring:: myst_parser.slugs.gitlab_slugify
          :summary:
   * - :py:obj:`unique_slug <myst_parser.slugs.unique_slug>`
     - .. autodoc2-docstring:: myst_parser.slugs.unique_slug
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`SLUG_PRESETS <myst_parser.slugs.SLUG_PRESETS>`
     - .. autodoc2-docstring:: myst_parser.slugs.SLUG_PRESETS
          :summary:

API
~~~

.. py:function:: github_slugify(title: str) -> str
   :canonical: myst_parser.slugs.github_slugify

   .. autodoc2-docstring:: myst_parser.slugs.github_slugify

.. py:function:: gitlab_slugify(title: str) -> str
   :canonical: myst_parser.slugs.gitlab_slugify

   .. autodoc2-docstring:: myst_parser.slugs.gitlab_slugify

.. py:data:: SLUG_PRESETS
   :canonical: myst_parser.slugs.SLUG_PRESETS
   :type: dict[str, collections.abc.Callable[[str], str]]
   :value: None

   .. autodoc2-docstring:: myst_parser.slugs.SLUG_PRESETS

.. py:function:: unique_slug(slug: str, existing: collections.abc.Container[str]) -> str
   :canonical: myst_parser.slugs.unique_slug

   .. autodoc2-docstring:: myst_parser.slugs.unique_slug