API reference
=============
.. py:currentmodule:: gmcapsule

These classes and functions are available to extension modules by importing
``gmcapsule``.

.. autosummary::

   Config
   Capsule
   Cache
   Context
   gemini.Request
   gemini.Identity


Classes
*******


Config
------
.. autoclass:: gmcapsule.Config
    :members:

Capsule
-------
.. autoclass:: gmcapsule.Capsule
    :members:

Cache
-----
.. autoclass:: gmcapsule.Cache
    :members:

Context
-------
.. autoclass:: gmcapsule.Context
    :members:

Request
-------
.. autoclass:: gmcapsule.gemini.Request
    :members:

Identity
--------
.. autoclass:: gmcapsule.gemini.Identity
    :members:


Functions
*********
.. autofunction:: get_mime_type

.. py:function:: markdown_to_gemini(src)

    Convert a Markdown document to Gemtext. Only basic Markdown features are
    supported, such as headings, unordered and ordered lists (without
    changing any numbering present in the source), blockquotes, and paragraph
    and line breaks.

    :param src: Markdown source text.
    :type src: str
    :return: Corresponding ``text/gemini`` source.
    :rtype: str