| Alerts | 31-Oct-2025 | place for page info badges | FAQ Item Content items Scroll Spy & Tabs | External content | alerts, github, permissions, documentation, added, contain, blocks, sources, docaroo, public | Learn how to add blocks to your content. You can add both and alerts. Alerts can contain content introduced in clear but also can refer from other documents from your documentation or from external public or private repositories. | place for page tags | place for page cats |
| Card | 26-Oct-2025 | place for page info badges | Link button Image Downloads | | card, galleries, docaroo, create, component, settings, links, embedding, documents, examples | Cards can be included as single items or in galleries of cards. | place for page tags | place for page cats |
| Components | 27-Sep-2025 | place for page info badges | Content items FAQ Item Scroll Spy & Tabs | Content items Content Introduction | components, formatting, tags, markdown, content, faq, document, embedded, inline, docaroo | Learn how to add different pre-defined and to your content. These are elements that can be embedded in your documents using tags. Pre- defined components represents the most efficient way to create complex and easy to maintain quality content. Content items are helpful liquid tags generating pieces of content. | place for page tags | place for page cats |
| Downloads | 27-Oct-2025 | place for page info badges | Link button Card XLSX Charts | | download, documentation, directory, link, button, external, generates, default, files, component | Download-link component generates a button link for downloading files from your documentation site. Only downloading from your site is allowed, for security reasons it is not allowed to create download links targeting files hosted on external sites. | place for page tags | place for page cats |
| FAQ Item | 27-Oct-2025 | place for page info badges | Alerts Content items Components | | faq, markdown, contain, search, header, adding, texts, format, content, readability | Docaroo supports 2 types of text search: native search and algolia docs search. We provide an advanced search based on different parameters such as the taxonomies. | place for page tags | place for page cats |
| Image | 27-Oct-2025 | place for page info badges | Card Downloads Content items | | captions, documentation, image, folder, component, pages, examples, content, render, stored | This component allows placing images into your content. Images can have captions (lets say you need to show some credits or copyright information) or not. The component is designed to work with responsive images. | place for page tags | place for page cats |
| Link button | 27-Oct-2025 | place for page info badges | Downloads Card Components | | links, bootstrap, add, click, button, permalink, docaroo, markdown, outline, navigate | Link buttons helps users to navigate inside your documentation or access external sites. Docaroo provides link buttons in style. You can add individual link buttons or group link buttons. | place for page tags | place for page cats |
| Rich media | 29-Oct-2025 | place for page info badges | Alerts Components External content | | embed, figma, docaroo, components, documentation, slides, prototypes, jam, decks, media | Learn how to use docaroo components to embed rich media into your content. Currently we support design, boards (fig jam), slides and deck files. Prototypes are not supported for the moment, we are working on this. | place for page tags | place for page cats |
| Scroll Spy & Tabs | 27-Oct-2025 | place for page info badges | Content items Alerts FAQ Item | | scroll, markdown, document, folder, spies, importing, stored, docaroo, ullamcorper, interdum | Scroll spies are great ways of organising information inside your documents. We made them flexible and easy to be included in the documents. Any docaroo component, including importing external content or rich content ones, can be used to populate scroll spies and tabs. | place for page tags | place for page cats |
| XLSX Charts | 27-Oct-2025 | place for page info badges | XLSX Tables Downloads PDF Summary | XLSX Tables | excel, charts, data, component, files, importing, formats, sheet, default, colours | This component allows importing excel charts into your documents. Combined with component, this one provides the full support to share structured data in a professional way. Currently we support only: line charts column and bar charts pie and doughnut charts we do not support importing the colours you assign to. | place for page tags | place for page cats |
| XLSX Tables | 27-Oct-2025 | place for page info badges | XLSX Charts Card Content items | XLSX Charts | markdown, tables, excel, column, widths, import, create, merged, loading, featured | This component allows users to create tables in markdown and load them in excel. It offers two types of tables: fully featured and without some features. | place for page tags | place for page cats |
| Content items | 27-Oct-2025 | place for page info badges | FAQ Item Alerts Scroll Spy & Tabs | Components Content Introduction | docaroo, documentations, content, useful, markdown, render, directory, repository, changes, github | Docaroo makes available a series of content items that can be used to enrich your documents and to be very efficient when wanting to incorporate pieces of content in a fast and robust way. | place for page tags | place for page cats |
| Content | 09-Nov-2025 | place for page info badges | External content Docs root Content items | Docs root | github, external, repository, content, document, importing, modify, features, sources, private | Learn how to structure and use the content in the most efficient way. The secret is to use to the maximum extent the features made available. Importing external content (at build time or at run time) is the most powerful. | place for page tags | place for page cats |
| External content | 27-Oct-2025 | place for page info badges | Alerts GitHub Content | Content Content items Alerts Components GitHub | docaroo, documentation, import, github, indexed, shortcodes, repositories, api, wordpress, features | Docaroo allows to your documents. External content is important because it allows you to create of content and import these parts in multiple places. It is possible to import content from external public and private GitHub repositories. | place for page tags | place for page cats |
| DOCX Summary | 27-Oct-2025 | place for page info badges | PDF Summary Experiments Downloads | PDF Summary | docx, generates, download, updates, component, document, huggingface, rendered, summary, source | This component helps enhancing your content with auto generated summaries from docx files. It is combined with the download component, so the output rendered will be a summary of the docx file and a download button. | place for page tags | place for page cats |
| Experiments | 27-Oct-2025 | place for page info badges | PDF Summary DOCX Summary | | experiments, features, pdf, build, generated, optimise, docx, summarise, dev, corrections | We are working on a series of interesting features that will make your life much easier when creating content. We consider those features as experiments. You are encouraged to use them and to send us your feedback. | place for page tags | place for page cats |
| PDF Summary | 27-Oct-2025 | place for page info badges | DOCX Summary Experiments XLSX Charts | DOCX Summary | pdf, generates, render, updates, component, huggingface, github, source, automatically, macos | This component helps enhancing your content with auto generated summaries from pdf files. It is combined with the download component, so the output rendered will be a summary of the pdf file and a download button. | place for page tags | place for page cats |
| Custom annotations | 31-Oct-2025 | place for page info badges | Custom notes Custom tags Sharing taxonomies | Custom notes | annotations, annotation, custom, comments, taxonomies, note, added, documents, placeholders, variant | Custom annotations are comments added by the user to parts of the documents. Can be seen and used only by theuser who created them. Working with custom annotations is possible only from the document body. | place for page tags | place for page cats |
| Custom categories | 31-Oct-2025 | place for page info badges | Custom tags Custom annotations Custom notes | Custom tags | categories, tags, custom, updating, removed, adding, features, category, removing, modified | Adding, removing and updating custom categories works exactly in the same way as the similar features related to the custom tags. The only feature that is not available for custom categories is adding custom categories to documents from selected text in the document body. | place for page tags | place for page cats |
| Custom notes | 31-Oct-2025 | place for page info badges | Custom annotations Custom categories Custom tags | Custom annotations | annotations, annotation, custom, notes, note, comments, documents, document, added, placeholders | Custom notes are comments added by the user to the documents. Can be seen and used only by theuser who created them. Working with custom notes is possible only from the document info panel. | place for page tags | place for page cats |
| Custom tags | 31-Oct-2025 | place for page info badges | Custom categories Custom annotations Sharing taxonomies | Custom categories Taxonomies | tags, taxonomies, docsearch, custom, removed, algolia, adding, words, selecting, feature | Custom tags can be added to the current document directly selecting a group of words (usually, max. 3 words or 20 characters) and applying tag document option (this feature is available on desktop only). If the site uses algolia docsearch, there is another feature available when selecting text in a. | place for page tags | place for page cats |
| Sharing taxonomies | 31-Oct-2025 | place for page info badges | Custom annotations Custom tags Custom notes | Taxonomies | taxonomies, taxonomy, custom, configuration, configure, sharing, workflows, allows, users, user | Sharing custom taxonomies is a feature that allows the users to save and load a certain custom taxonomy configuration. This means that custom taxonomicies can be used by may users or, maybe even more important, a user can configure multiple custom taxonenies and load them to fit the purpose of. | place for page tags | place for page cats |
| Taxonomies | 07-Nov-2025 | place for page info badges | Sharing taxonomies Custom notes Custom annotations | Sharing taxonomies Custom tags | taxonomies, workflows, customised, tags, annotations, features, plugins, users, posts, backend | Custom taxonomies allow users to organise the information in a way that suits their preference. There is no limit in how many ways the documentation can be organised using custom taxonomyies. | place for page tags | place for page cats |
| Docs root | 09-Nov-2025 | place for page info badges | Config Options Get started Introduction | Content | folders, documentation, faq, repository, permalink, sections, doc, downloading, page, file | Doc-contents is the root folder of the documents and collections. The way in which this folder is organised is strictly depending on the structure you want to have for your documentation. | place for page tags | place for page cats |
| Environments | 05-Oct-2025 | place for page info badges | GitHub Deploy Config Options | | env, variables, settings, netlify, github, repositories, include, dev, deploying, purposes | Environment variables are used only at build time. At run time (in dev or production environments) the environment variables are not used anymore. They are mostly used to store values that should never be exposed, such as access keys and tokens that are used to integrate some external features and. | place for page tags | place for page cats |
| Extend | 08-Nov-2025 | place for page info badges | GA/GTM | | hookable, extend, javascript, plugins, gtm, function, scope, parameters, globals, inline | We offer out-of-the-box the possibility to extend the functionality of the site by hooking on the execution of the functions on browser side. The hook is set by method which takes the following parameters: : the name of the target function : array of values which will be attached to. | place for page tags | place for page cats |
| Get started | 27-Oct-2025 | place for page info badges | Introduction Docs root Config Files | Deploy | documentation, docaroo, python, blog, customising, directory, keywords, macos, install, framework | Getting started with docaroo requires, first of all, to design your documentation. Organising well your documentation (or blog) is crucial. This will involve defining the folder structure and also the taxonomies. Docaroo can take care of automatically generating other information about you documentation. | place for page tags | place for page cats |
| Set appearance | 29-Oct-2025 | place for page info badges | Build and test Deploy Go live | | settings, website, logo, appearance, header, themes, sidebar, config, html, title | Setting the appearance means to set the branding an colors of the site. Branding elements are the logo, the site title, the additional buttons on the header and the footer visible at the bottom of the left sidebar. Additionally the following colors can be set: background and text colors for. | place for page tags | place for page cats |
| Build and test | 30-Oct-2025 | place for page info badges | Deploy Go live Set appearance | Get started | build, github, sites, tests, generate, docaroo, deploy, sections, permalink, process | Building and testing the site means go generate the site, running the automatic testing and the spell checking. Following the site build and tests results, corrections may be needed. When everything is fine, is time to serve the site locally and test its appearance and functionality. | place for page tags | place for page cats |
| Deploy | 10-Nov-2025 | place for page info badges | Build and test Go live Set appearance | Get started GitHub | deploying, hosting, netlify, github, configuring, process, env, build, update, docaroo | Deploying the site means to update the production environment (such as on-prem, or github pages or netlify, or similar) this is the next step after building and testing the site. Docaroo provides out-of-the-box actions to deploy on github pages and on netlifying. | place for page tags | place for page cats |
| Go live | 28-Oct-2025 | place for page info badges | Deploy Build and test Set appearance | Build and test | netlify, github, live, tests, site, branding, tuning, update, pages, functionality | Going live with the site is a pretty straight forward process. It involves tuning of the appearance (if needed), building and testing in the development environment and publishing (deploying) in production environment. We make available the necessary tools for each step of this process. | place for page tags | place for page cats |
| Algolia | 28-Oct-2025 | place for page info badges | GitHub HubSpot New Relic | Get started | docsearch, docaroo, algolia, integration, documentation, index, github, manually, option, settings | Docaroo provides out-of-the-box full integration with algolia docsearch. The search experience has multilanguage support by default. | place for page tags | place for page cats |
| GA/GTM | 28-Oct-2025 | place for page info badges | HubSpot New Relic Extend | New Relic | gtm, buildconfig, tags, analytics, google, hookable, custom, enabled, deploy, default | Google analytics and google tag manager are installed by default if enabled and configured in _databuildconfig.yml. This will enable the collection of data about the site. When ga and gtm are connected, ga collects the information available when a gtm tag fires. However, the most important feature of the integration. | place for page tags | place for page cats |
| GitHub | 28-Oct-2025 | place for page info badges | Algolia Environments HubSpot | Deploy | github, docaroo, repositories, api, caching, limits, settings, imported, accessed, dev | Docaroo integration allows you to import content from public and private repositories. For the private repositories, content can be imported only from the repositories within the scope of the personal access token that must be configured. At the moment, we do not support importing content from private repositories at run. | place for page tags | place for page cats |
| HubSpot | 28-Oct-2025 | place for page info badges | Algolia GA/GTM GitHub | | hubspot, tracking, feedback, enabled, portalid, documentation, embed, feature, configure, custom | Hubspot tracking code is installed by default if hubspot integration is enabled in . This will enable the features that are related to the tracking code such as monitoring the visits on the site. The feedback form can be located on the right-bottom corner of each page. | place for page tags | place for page cats |
| Integrate | 25-Oct-2025 | place for page info badges | New Relic Config Files Algolia | | docaroo, integrations, api, purpose, configuration, provides, env, enabled, files, feedback | Docaroo provides out-of-the-box a series of integrations. The main purpose is to enhance the functionalities of the site. Each integration can be independently enabled and configured or disabled. | place for page tags | place for page cats |
| New Relic | 28-Oct-2025 | place for page info badges | Algolia GA/GTM Integrate | GA/GTM | documentation, integration, activate, relic, new, configured, scope, interactions, github, log | New relic integration is provided out-of-the-box once this integration is enabled. This integration allows monitoring and measuring the performance of the site. Used in combination with the extension capabilities, it provides a robust way to log the user interactions with site. | place for page tags | place for page cats |
| Introduction | 08-Nov-2025 | place for page info badges | Get started Docs root Config Files | Components Content items Content | documentation, markdown, docaroo, developer, create, guide, faqs, excel, contributor, onboarding | Documentation site builder guide for any kind of project, product, or organization. Walk you through everything you need to know about building a complete, maintainable, and professional documentation site from scratch. | place for page tags | place for page cats |
| Maintain | 10-Nov-2025 | place for page info badges | Docs root Get started Introduction | | documentation, iawriter, markdown, maintaining, repository, editor, zettlr, tags, update, site | Maintaining the documentation is about keeping the content up-to-date, removing obsolete content or adding new content. Updating content can be related to refreshing the associated taxonomies (site tags, site categories). | place for page tags | place for page cats |
| Config Files | 27-Oct-2025 | place for page info badges | Config Options Docs root Get started | Config Options | docaroo, configuration, config, configurations, configure, options, files, functionality, folder, yml | Docaroo provide multiple options to configure the the site functionality and appearance. Each time when a configuration is changed, it is necessary to re-build the site to make the configuration effective. | place for page tags | place for page cats |
| Config Options | 30-Oct-2025 | place for page info badges | Config Files Docs root Get started | Config Files | config, options, documentation, personalisation, functionalities, dev, appearance, modified, sections, mode | All the options available for site appearance and functionalities are shown in the next table. These options are available in _config.yml or in the configuration files and will allow personalisation of the documentation site. Note the site must be built and deployed (where applicable) in order to make new config. | place for page tags | place for page cats |
