.. xettel documentation master file, created by
   sphinx-quickstart on Mon Jun 21 11:23:26 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to xettel's documentation!
==================================

``xettel`` is a Zettelkasten_ management software backed by xapian_.

.. _Zettelkasten: https://en.wikipedia.org/wiki/Zettelkasten
.. _xapian: https://xapian.org

``xettel`` provides a way to store your Zettels in a Zettelkasten that allows
for full-text search using ``xapian`` as its backend. The interface ``xettel``
provides searching is similar to that of notmuch_. One of the core design
principles of ``xettel`` is to be completely agnostic as to the format the
end-user stores their Zettels in. Should they wish to store their Zettels in an
exotic format, say, ``.docx``, if they are able to provide a class that extracts
the information for ``xettel``, they will be able to use the software just like
with simple ``markdown`` files.

Beyond providing a search interface, ``xettel`` also provides ways to export the
Zettels in another format, for instance, ``.html``, health checks such as
weak-connectivity of the whole Zettelkasten and can also produce a map of the
links.

.. _notmuch: https://notmuchmail.org/

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   :glob:

   installation
   quickstart
   cli
   config
   extending
   api/index
   neovim
   contributing




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

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