.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/plot_quick_start.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_plot_quick_start.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_plot_quick_start.py:


Quick Start
===========

The simplest way to create a meme with memeplotlib.

.. GENERATED FROM PYTHON SOURCE LINES 9-15

Your First Meme
----------------

The :func:`~memeplotlib.meme` function creates a meme from a template ID.
The first positional argument is the template, and subsequent arguments are
text lines placed at the template's text positions (typically top and bottom).

.. GENERATED FROM PYTHON SOURCE LINES 15-20

.. code-block:: Python


    import memeplotlib as memes

    memes.meme("buzz", "memes", "memes everywhere", show=False)




.. image-sg:: /auto_examples/images/sphx_glr_plot_quick_start_001.png
   :alt: plot quick start
   :srcset: /auto_examples/images/sphx_glr_plot_quick_start_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    findfont: Font family ['Impact'] not found. Falling back to DejaVu Sans.

    (<Figure size 1200x912.548 with 1 Axes>, <Axes: >)



.. GENERATED FROM PYTHON SOURCE LINES 21-26

Saving to a File
-----------------

Pass ``savefig`` to write the meme to disk.  Set ``show=False`` to suppress
the interactive window.

.. GENERATED FROM PYTHON SOURCE LINES 26-28

.. code-block:: Python


    memes.meme("doge", "such code", "very bug", savefig="doge_example.png", show=False)



.. image-sg:: /auto_examples/images/sphx_glr_plot_quick_start_002.png
   :alt: plot quick start
   :srcset: /auto_examples/images/sphx_glr_plot_quick_start_002.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    (<Figure size 1200x1200 with 1 Axes>, <Axes: >)




.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.999 seconds)


.. _sphx_glr_download_auto_examples_plot_quick_start.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_quick_start.ipynb <plot_quick_start.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_quick_start.py <plot_quick_start.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_quick_start.zip <plot_quick_start.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_