DOCSEARCHbyAlgolia
Submit Docs

Docuo Documentation

website·Indexed 32 days ago

https://fzytest.spreading.io

Docuo is a lightweight platform and modern static website generator that converts static content into documentation sites. It features MDX component support, a versioning CLI, multi-instance hosting for distinct documentation sets, and official integration with Algolia DocSearch. Site customization is managed via the platform interface or a `docuo.config.json` configuration file.

Tokens
19.7K
Snippets
115
Records
170
Agent score
39%

What's inside Docuo

  1. Overview of Docuo documentation platform

    Docuo is a lightweight platform that converts static content into dynamic, modern technical websites. It is primarily used to create developer hubs, API references, and product guides to help companies better engage their end users.

  2. Overview of Docuo documentation versioning

    Docuo allows you to preserve specific sets of documentation as versions. The docs/ directory contains the 'current' version (default label 'Next', hosted at /docs/next/*). Versioned documentation is stored in the versioned_docs/ directory, where each subfolder represents a specific version. The versions.json file maintains an ordered list of available version names from newest to oldest.

    Key Terminology:

    • Current version: The version located in the ./docs folder.
    • Latest version: The version served by default for navbar items (usually at /docs).

    URL Mapping Example:

    • docs/hello.md $\rightarrow$ /docs/next/hello (Current)
    • versioned_docs/version-1.1.0/hello.md $\rightarrow$ /docs/hello (Latest)
    • versioned_docs/version-1.0.0/hello.md $\rightarrow$ /docs/1.0.0/hello (Older)

  3. Overview of Docuo core features

    Docuo provides a suite of tools for documentation management, including:

    • Git-based Versioning: Sync documentation versions with product releases using Git repositories.
    • Multi-instance Hosting: Support for hosting multiple distinct documentation sets (e.g., for different platforms or sub-products).
    • Dev-first code group: Syntax highlighting for code snippets in over 50 languages.
    • Interactive API Playground: Ability to execute real API requests directly from the documentation.
    • Rich docs components: Over 20 built-in components to enhance content presentation.
    • Built-in Feedback & Analytics: Tools to track user engagement and conversion points.
    • Customized Styling & Layout: Branding and personalization options for the documentation site.
    • Advanced Searching: Optimized search functionality to help users find content quickly.
    • Comprehensive SEO Support: Tools to improve organic traffic through optimized article content.

  4. Overview of Docuo core features

    Docuo provides a suite of tools for managing and presenting technical documentation, including:

    • Git-based Versioning: Syncs documentation versions with product releases via Git repositories.
    • Multi-instance Hosting: Supports hosting multiple distinct documentation sets (e.g., for different platforms or sub-products).
    • Dev-first code group: Provides syntax highlighting for code snippets in over 50 languages.
    • Interactive API Playground: Allows users to execute real API requests directly from the documentation.
    • Rich docs components: Includes 20+ specialized components to improve content comprehension.
    • Built-in Feedback & Analytics: Tracks user engagement and conversion points.
    • Customized Styling & Layout: Allows brand-specific personalization of the documentation site.
    • Advanced Searching: Optimized search functionality to help users find relevant content.
    • Comprehensive SEO Support: Tools to increase organic traffic through optimized article content.

  5. Overview of Docuo platform capabilities

    Docuo is a lightweight platform designed to convert static content into dynamic, modern technical documentation sites. It is primarily used to generate developer hubs, API references, and product guides to help companies improve end-user engagement.

  6. Overview of Docuo documentation versioning

    Docuo allows you to preserve specific sets of documentation as versions. The docs/ directory contains the 'current' version (default label 'Next', hosted at /docs/next/*). Versioned content is stored in versioned_docs/, and the available versions are tracked in versions.json (ordered newest to oldest).

    Key Terminology:

    • Current version: The version located in the ./docs folder.
    • Latest version: The version served by default for navbar items (usually at /docs).

    URL Mapping Example:

    • docs/hello.md $\rightarrow$ /docs/next/hello (Current)
    • versioned_docs/version-1.1.0/hello.md $\rightarrow$ /docs/hello (Latest)
    • versioned_docs/version-1.0.0/hello.md $\rightarrow$ /docs/1.0.0/hello (Older version)

  7. Overview of Docuo core features

    Docuo provides a suite of tools for managing developer documentation, including:

    • Git-based Versioning: Syncs documentation versions with product releases using Git repositories.
    • Multi-instance Hosting: Supports hosting multiple distinct documentation sets (e.g., for different platforms or sub-products).
    • Dev-first code group: Provides syntax highlighting for over 50 languages.
    • Interactive API Playground: Allows users to execute real API requests directly from the documentation.
    • Rich docs components: Includes 20+ specialized components to improve content comprehension.
    • Built-in Feedback & Analytics: Tracks user engagement and conversion points.
    • Customized Styling & Layout: Allows brand-specific personalization of the documentation site.
    • Advanced Searching: Optimized search functionality to help users find specific content.
    • Comprehensive SEO Support: Tools to increase organic traffic through optimized article content.

  8. Overview of Docuo documentation platform

    Docuo is a lightweight platform designed to convert static content into dynamic, modern technical websites. It is primarily used to create developer hubs, API references, and product guides to help companies better engage their end users.

  9. Host multiple documentation sets using Docuo Multi-instance

    Docuo allows a single site to host two or more distinct sets of documentation. This is particularly useful when managing documentation for different platforms (e.g., Android SDK vs. iOS SDK) that may require separate versioning, configurations, and entity files. Note: If the documentation instances are exceptionally large, it is recommended to create separate Docuo sites instead of multiple instances within one site.

  10. Host multiple documentation instances in a single Docuo site

    Docuo allows a single site to host two or more distinct sets of documentation. This is particularly useful for cross-platform projects (e.g., separate Android and iOS SDK documentation) where each set requires its own versioning, configuration, and entity files. Note: If the documentation instances are exceptionally large, it is recommended to create separate Docuo sites instead of multiple instances.

  11. Host multiple documentation sets using Docuo Multi-instance

    Docuo allows a single site to host two or more distinct sets of documentation. This is particularly useful for cross-platform products (e.g., separate Android and iOS SDKs) where each set of documentation requires its own versioning, configuration, and entity files. Note: If the documentation instances are exceptionally large, it is recommended to create separate Docuo sites instead of multiple instances.

  12. Understand Docuo documentation versioning concepts

    Docuo allows you to freeze a specific set of documentation into a version, preserving it while the main docs directory continues to evolve.

    Key Terminology:

    • Current version: The documentation located in the ./docs folder. By default, this is labeled as 'Next' and hosted under /docs/next/*.
    • Latest version: The version served by default for documentation navbar items (usually at the /docs path).

    Note: The 'Current' version (file system location) and 'Latest' version (navigation behavior) can be different.