Skip to main content

About this documentation

This documentation is work in progress, the articles are being updated on a regular base.

Documentation structure​

This documentation is built using Docusaurus, for a streamlined and simple user experience. Each page will concern a particular topic, giving detailed and illustrated explanations and instructions about it. Every page is broken down to different level headings.

The navigation sidebar on the left side of this page will represent the chapters as expandable topics, with the sections listed in each expanded view.

Illustrations​

For preparing the screenshots for this documentation we use shapes from the following SVG file.

Shapes for preparing graphics

We used another great open source product called Inkscape for the creation of the graphics.

The color of the shapes has the following HEX encoding: #ef2dae

Text markup​

You will notice, that certain words are marked with bold text. These either mean names of elements, or significant notes/concepts about usage. Italicized words usually mark menu items, or other selectable elements, although it is not a hard and fast rule.

Bulleted lists will be used to

  • Improve readability
  • Make it easier to find what you are looking for.

Document symbols​

There are currently two types of symbols, apart from the usual text formatting and annotations, that you can find on these pages:

  • PRO - means that the described feature is part of the TagSpaces Pro and Enterprise editions.
  • ⚒ - means that the section is not ready yet and may contain unclear, or not up-to-date information, or sections might be missing entirely.

Contribution​

This documentation project is hosted on GitHub, and uses the Docusaurus MD format. Enhancement, or corrections are welcome via pull requests. For the markdown syntax used for the document please refer to the Style Guide

Credits​

Original text and images in this documentation were created and edited by:

Articles published on the TagSpaces Blog, served as the basis upon which this documentation was built. Fragments of the original text can still be found in the documentation, without marking the original author.

License of the documentation​

TagSpaces Documentation by TagSpaces Authors is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Based on a work at https://github.com/tagspaces/documentation.


Creative Commons License