Docaroo Frequent Asked Questions

Docaroo is designed for documentation sites and blogs. It is designed for easy content development and deployment and it is focused on content presentation and readibility.

Comparing with similar products, Docaroo:

  • Is easy yo install and maintain and is focused on easy content creation with markdown files (from very simple to quite complex markdown files)
  • Comes with ready-made components to be easily included into your content
  • Provides powerful features to create reusable pieces of content, including by importing it from other document of your site or from external sources
  • Comes with ready-built multilanguage deployment procedures.
  • Provides out-of-the-box custom taxonomies features
  • Comes with out-of-the-box automatic features to enrich your content with keywords and doc summary generation
  • Comes with out-of-the-box automatic features to detect related and similar documents

Yes, Docaroo is free forever. Download it from Github, install it, create your content and use it without any restriction.

Docaroo offers the possibility to style it and extend it as you need. The configuration files allows different levels of configuration which requires low programming skills or no coding at all. The hooks system allows extension of the functionalities on licent side. Apart from these, Docaroo is open source, you can customise it as you want by modifiyng its code, without any restriction. However, we would appreciate the ususl Github flow, forking, customising and create pull requests, so the whole community could benefit.

Yes, any Docaroo component can be used inside FAQ answers. Here is an example.

YouTube Thumbnail

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris sagittis dolor nec porttitor feugiat. Fusce interdum, lacus eget tincidunt porta, mi nibh auctor velit, non dapibus dolor velit et leo.Mauris semper nisi in elementum finibus. Aenean finibus, erat vitae cursus fringilla, ligula turpis maximus eros, quis rutrum elit mi non lacus. Aliquam sapien sapien, consequat ultrices ex sed, vehicula lacinia mauris. Donec eget ipsum vehicula dolor luctus consectetur ut nec lectus. Nunc magna arcu, rhoncus varius hendrerit nec, fringilla id urna. Sed mollis eget orci ut eleifend. Sed purus lorem, dictum non eros et, posuere sodales magna.

Docaroo is, in essence, a Jekyll site optimised for deployment with Github pages, although any other deployment is possible. So, the core of Docaroo is based mostly on Ruby and Javascript. However, some of the features (such as automatic keywords and summary generation, detecting related and similar pages) are based on Python.

Yes, Docaroo supports multilanguage. However, automatic deployment of a Docaroo multilanguage site is fully supported only with Github pages. For other deployments you need to handle it depending on your production environment. We also support automatic deployment with Netlify, but only for single-language Docaroo instances.

Docaroo suports 2 types of text search:

  • Native search
  • Algolia Docs search

Additionally, we provide an advanced search based on different parameters such as the taxonomies.

When using Algolia DocSearch, the run-time rendered content is indexed, thus searchable. When using native search, the run-time rendered content is not indexed, thus not returned by the search queries.

Docaroo comes by default with the possibility to assign categories and tags to your documents (site taxonomies). Additionally, custom taxonomies feature is available. As such, the users can define and use their own custom tags and categories. Notes to documents and annotations (comments) features are available. Cutom taxonomies can be saved as local files then can be loaded as needed or shared with teammates.

There is no restriction in defining/saving/sharing custom taxonomy configurations. This allows organising the documentation in different ways, serving different purposes.However, only one can be active.