Welcome to hfmirror's Documentation
================================================

Overview
-------------

The `hfmirror` framework provides a user-friendly set of resources for mirroring items to various storage mediums, including local disks and Hugging Face repositories.

.. toctree::
    :maxdepth: 2
    :caption: Tutorials

    tutorials/installation/index


.. toctree::
    :maxdepth: 2
    :caption: Best Practice

.. toctree::
    :maxdepth: 2
    :caption: API Documentation

    api_doc/config/index
    api_doc/resource/index
    api_doc/storage/index
    api_doc/sync/index
    api_doc/utils/index


.. toctree::
    :maxdepth: 2
    :caption: Contributor Guide