NodeBB/docs/index.rst

.. image:: http://i.imgur.com/3yj1n6N.png

|
**NodeBB** is a next-generation discussion platform that utilizes web sockets for instant interactions and real-time notifications. NodeBB forums have many modern features out of the box such as social network integration and streaming discussions.

NodeBB is an open source project which can be forked on `GitHub <https://github.com/designcreateplay/NodeBB/>`_. Don't forget to check out the ways that you can help contribute to this project, from translations, pull requests, and telling your friends.

Table of Contents
=================

.. _installing:

Installing NodeBB
-----------------

.. toctree::
   :maxdepth: 2

   installing/os
   installing/cloud


.. _configuring:

Configuring NodeBB
------------------

.. toctree::
    :maxdepth: 2

    configuring/databases
    configuring/proxies

Administrating NodeBB
---------------------

.. toctree::
    :maxdepth: 2

    admin/outline
    admin/sso
    admin/uploads

Contributing to NodeBB
----------------------

.. toctree::
    :maxdepth: 2

    contributing/style-guide
    contributing/resources

Plugin System
-------------

.. toctree::
    :maxdepth: 2

    plugins/create
    plugins/hooks
    plugins/resources

Widgets System
--------------

.. toctree::
    :maxdepth: 2

    widgets/create
    widgets/resources

Theming Engine
--------------

.. toctree::
    :maxdepth: 2

    themes/create
    themes/templates
    themes/resources

Internationalization
--------------------

.. toctree::
    :maxdepth: 2

    i8n/transifex

Helping out the NodeBB Project
------------------------------

.. toctree::
    :maxdepth: 2

    helping/contribute
    helping/share

Writing Documentation
---------------------

.. toctree::
    :maxdepth: 2

    docs/sphinx

Troubleshooting / Help
----------------------

.. toctree::
    :maxdepth: 2

    help/faq
    help/bugs
    help/help

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

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