You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
nodebb/docs/index.rst

114 lines
1.8 KiB
ReStructuredText

11 years ago
.. image:: http://i.imgur.com/3yj1n6N.png
11 years ago
11 years ago
|
**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
=================
11 years ago
.. _installing:
11 years ago
Installing NodeBB
-----------------
11 years ago
.. toctree::
:maxdepth: 2
installing/os
installing/cloud
.. _configuring:
Configuring NodeBB
------------------
.. toctree::
:maxdepth: 2
11 years ago
configuring/databases
configuring/proxies
Administrating NodeBB
---------------------
.. toctree::
:maxdepth: 2
admin/outline
admin/sso
admin/uploads
Contributing to NodeBB
----------------------
.. toctree::
:maxdepth: 2
contributing/style-guide
Plugin System
-------------
.. toctree::
:maxdepth: 2
plugins/create
plugins/hooks
Widgets System
--------------
.. toctree::
:maxdepth: 2
widgets/create
Theming Engine
--------------
.. toctree::
:maxdepth: 2
themes/create
themes/templates
Developer's Resources
---------------------
.. toctree::
:maxdepth: 2
resources
Helping out the NodeBB Project
------------------------------
.. toctree::
:maxdepth: 2
helping/contribute
helping/share
helping/documentation
Troubleshooting / Help
----------------------
.. toctree::
:maxdepth: 2
help/faq
help/bugs
help/help
11 years ago
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`