.. markdown2canvas documentation master file, created by
   sphinx-quickstart on Wed Jul 10 13:17:30 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

`markdown2canvas`
===========================================

This is the documentation for `markdown2canvas`, a Python library for containerizing and publishing Canvas content.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Tutorials
================

.. toctree::
   :maxdepth: 1

   tutorials/setup_mac_linux
   tutorials/setup_windows
   tutorials/making_your_first_course
   tutorials/writing_content
   tutorials/styling_content
   tutorials/text_replacements
   tutorials/publishing_content
   


Notes
========

.. toctree::
   :maxdepth: 1
   :caption: Some useful notes on aspects of using the library

   on_meta_dot_json
   making_links_to_existing_content
   wishlist


Useful links
==============

* `Canvas API documentation at root level <https://canvasapi.readthedocs.io/en/stable/>`_
* `Canvas API class documentation <https://canvasapi.readthedocs.io/en/stable/class-reference.html>`_  I use this when chasing down how to set additional properties for various content types.  



Details 📝
================

.. toctree::
   :maxdepth: 0
   :caption: Contents:

   markdown2canvas


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Contact 📧
=================

If you have any questions or problems, please `submit an issue on github <https://github.com/ofloveandhate/markdown2canvas/issues>`_!