Docuo Documentation

website·Indexed 32 days ago

https://sunlyproject1-hdh34.spreading.io

A lightweight platform that converts static content into documentation websites. Docuo provides tools for project setup, content connection, and website customization via a platform interface or a `docuo.config.json` file, supporting MDX components and custom sidebar management.

Tokens
8.6K
Snippets
49
Records
71
Agent score
49%

What's inside Docuo

  1. Understand Docuo product pricing tiers

    Docuo offers three pricing tiers based on user type and feature requirements:

    • Free: For individual users; supports single-member, single-project publishing.
    • Startup (Basic Paid): For small teams; supports multi-member, single-project editing and publishing via the MDX editor.
    • Enterprise (Advanced Paid): For medium to large teams; supports multi-member, multi-project editing and publishing via the visual editor.
  2. Create and set up a first project in Docuo

    To create a new documentation website project in Docuo, follow these steps:

    1. Account Creation: Create a personal account at https://app.spreading.ai/signup/ and verify your email, or sign up using a Google account.
    2. GitHub Authorization: Sign in with GitHub and authorize the Docuo OAuth app. This allows Docuo to manage your documentation repositories and publish content to the website.
    3. Initialize Repository: Use the provided template repository by clicking "Create". Docuo will clone the public template repository into your own GitHub account.
    4. Project Configuration: Define your project name and site subdomain. If the requested subdomain is already taken, contact docuo@spreading.ai to check availability.
    5. Deployment: After completing the setup, the site enters a publishing status (taking approximately 1-2 minutes). Once published, the site link will be available on your project homepage.
  3. Configure code blocks and syntax highlighting

    Support is provided for inline code (backticks) and fenced code blocks (triple backticks). Fenced blocks support language tags for syntax highlighting, line highlighting using curly brackets, custom filenames, and a hideLineNumbers flag.
    `inline code`
    
    ```jsx {1,4-6} myFile.jsx hideLineNumbers
    import React from 'react';
    // ... code
  4. Manage Docuo Startup trial and expiration

    Every workspace receives a 14-day free trial of the Startup version. Upon expiration:

    • The console becomes unusable.
    • If the trial is expired for more than 7 days, the corresponding project is released from the Vercel team.
    • Published sites cannot be updated (automatic publishing from Git is disabled) and become inaccessible.
    • Users entering the console will see an expiration prompt directing them to the [Plans] page for purchase.
    • Small tools remain usable.
    • If the user switches to the official Free version after the trial, the project is moved back to the free user public team.
    • If the user purchases the Startup version, the project is migrated to the paid user dedicated team.
  5. Customize website identity via the platform

    You can update your website's identity elements directly through the project's Customize tab in the platform settings. The available customizable fields include the website title, the header logo (including its redirect URL), and the favicon. Changes are applied to the website immediately after saving the customization settings.