.. TiddlyWeb documentation master file, created by
   sphinx-quickstart on Tue Sep  3 15:59:47 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. toctree::
   :maxdepth: 1
   :hidden:
   :glob:

   tiddlyweb*

TiddlyWeb
=========

TiddlyWeb is an open source `HTTP API`_  for storing and accessing
flexible and composable microcontent. It is also a toolkit for
`tiddlers`_ on the web and a robust server side for `TiddlyWiki`_.

.. _HTTP API: http://docs.tiddlyweb.com/HTTP%20API
.. _tiddlers: http://docs.tiddlyweb.com/tiddler
.. _TiddlyWiki: http://tiddlywiki.com/

TiddlyWeb by itself provides the base HTTP API, storage engine and
default serializations. A large variety of `plugins`_ provide
additional functionality.

.. _plugins: https://pypi.python.org/pypi?%3Aaction=search&term=tiddlywebplugins

Quick Start
-----------

The quickest way to get going with an operational installation of
TiddlyWeb is to install `tiddlywebwiki`_.

See the `quick start`_ documentation for that.

.. _tiddlywebwiki: https://pypi.python.org/pypi/tiddlywebwiki
.. _quick start: http://docs.tiddlyweb.com/Quick%20Start

Additional Documentation
------------------------

Besides package documentation starting at :doc:`tiddlyweb`, additional
documentation can be found at http://tiddlyweb.com and
http://docs.tiddlyweb.com/.

Note that all of this documentation is in a constant state of flux, as
it should be. If you find an error please help to fix it.

Source
------

The TiddlyWeb source is kept at `GitHub`_.

.. _GitHub: https://github.com/tiddlyweb/tiddlyweb

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