Dumi Expert-Static Site Framework for Components

Effortlessly create and manage component documentation.

Home > GPTs > Dumi Expert
Rate this tool

20.0 / 5 (200 votes)

Dumi Expert Introduction

Dumi Expert, pronounced 'Doo-mee', is a specialized static site framework designed for component development scenarios. It, along with the tool 'father', provides developers with a one-stop component development experience. While 'father' handles the component source code construction, Dumi is responsible for component development and documentation generation. This framework offers significant features like improved compilation performance, built-in full-text search without third-party services, a new theme system with plugin and internationalization support, enhanced convention routing, and asset metadata 2.0 for a broader range of possibilities in asset circulation. It's specifically optimized for component development, offering an integrated scaffolding with the new NPM package development tool 'father 4', thus delivering a seamless development experience. Powered by ChatGPT-4o

Main Functions of Dumi Expert

  • Improved Compilation Performance

    Example Example

    Dumi 2.0 utilizes Umi 4 MFSU, esbuild, SWC, and persistent caching for faster compilation times compared to Dumi 1.x.

    Example Scenario

    Developers experience reduced waiting times for compilation, making the development process more efficient.

  • Built-in Full-text Search

    Example Example

    Dumi provides a built-in search feature that indexes titles, text, and demos without needing external services.

    Example Scenario

    Users can quickly find relevant content in the documentation without external dependencies, enhancing the usability of the documentation site.

  • New Theme System

    Example Example

    The new theme system supports plugins and internationalization, offering part-override capabilities similar to Docusaurus.

    Example Scenario

    Theme users can easily customize and extend their documentation site with more powerful and user-friendly options.

  • Convention Routing Enhancement

    Example Example

    Dumi simplifies routing configuration by splitting routing concepts, making it more intuitive compared to Dumi 1.x.

    Example Scenario

    Developers can easily set up and understand the routing of their documentation site, leading to a smoother development process.

  • Asset Metadata 2.0

    Example Example

    Based on 1.x and JSON Schema, Dumi designs a new structure for asset property definitions, facilitating more possibilities in asset circulation.

    Example Scenario

    Enables more flexible and powerful asset management and integration within the component development workflow.

  • Seamless Integration with Father 4

    Example Example

    Provides a scaffold integrated with the latest NPM package development tool 'father 4', offering a one-stop development experience.

    Example Scenario

    Developers benefit from a cohesive toolchain that simplifies component development and documentation, enhancing productivity.

Ideal Users of Dumi Expert Services

  • Component Library Developers

    Developers creating reusable UI components or libraries can leverage Dumi Expert for developing, testing, and documenting their components efficiently.

  • Documentation Site Creators

    Technical writers and developers looking to create rich documentation sites with enhanced search capabilities and intuitive navigation.

  • Front-end Developers

    Front-end developers in need of a framework that integrates seamlessly with modern development tools and practices for component development and documentation.

Usage Guidelines for Dumi Expert

  • Step 1

    Visit yeschat.ai for a free trial without login, also no need for ChatGPT Plus.

  • Step 2

    Explore the features and capabilities provided by Dumi Expert, including component development, documentation generation, and enhanced Markdown syntax.

  • Step 3

    Follow the directory structure conventions to organize your project's documentation and source code efficiently.

  • Step 4

    Utilize the built-in search functionality to quickly locate relevant documentation or components within your project.

  • Step 5

    Experiment with the customizable theme system and runtime configurations to tailor the appearance and behavior of your documentation site.

Frequently Asked Questions about Dumi Expert

  • What is Dumi Expert?

    Dumi Expert, pronounced 'Doo-mee', is a static site framework designed for component development scenarios. It works alongside 'father' to provide developers with a one-stop component development experience, where 'father' handles component source code building, and Dumi Expert manages component development and documentation generation.

  • What are the key features of Dumi Expert 2.0?

    Dumi Expert 2.0 features improved compilation performance through the use of Umi 4 MFSU, esbuild, SWC, and persistent caching. It offers built-in full-text search capabilities, a new theme system, enhanced conventional routing, a revamped asset metadata 2.0 structure, and is built specifically for component research and development.

  • How can I customize the theme of my documentation site?

    Dumi Expert provides a new theme system that supports plugins and internationalization, allowing theme users to partially override the theme for more customization options. You can create global styles and scripts, configure runtime settings, and use a custom loading component to tailor the theme to your needs.

  • How does Dumi Expert handle multi-language support?

    Dumi Expert allows for multi-language support by adding multiple language configurations in the '.dumirc.ts' file under the 'locales' option. You can then create Markdown files for different languages following a naming convention, such as 'index.en-US.md' for English content.

  • What is the purpose of the auto API table feature?

    The auto API table feature in Dumi Expert is designed to automatically generate API tables for React components based on JSDoc and TypeScript type definitions. This significantly lowers the maintenance cost of API documentation by ensuring that component properties and descriptions are up-to-date and accurate.