CTFd/docs/index.rst

41 lines
1.2 KiB
ReStructuredText

.. CTFd documentation master file, created by
sphinx-quickstart on Tue Apr 9 15:14:45 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
CTFd
====
.. image:: https://raw.githubusercontent.com/CTFd/CTFd/master/CTFd/themes/core/static/img/logo.png
:width: 400
:alt: CTFd Logo
CTFd is a Capture The Flag framework focusing on ease of use and customizability.
CTFd comes with most of the features needed by an event organizer to run a competition or workshop. In addition, if CTFd's feature set is insufficient, CTFd allows for the usage of plugins and themes to control almost every aspect of how it looks and behaves.
CTFd is used by many different clubs, universities, and companies to host their own Capture The Flags.
While available as open source, CTFd developers also provide a managed hosting service available at https://ctfd.io/.
CTFd is written in Python and makes use of the Flask web framework.
.. toctree::
:maxdepth: 2
:caption: Contents:
deployment
configuration
scoring
themes
plugins
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`