umijs/dumi

Features

• Live Code Demonstrations - Extracts and renders runnable code snippets from markdown as interactive components directly in the browser.
• Documentation Site Generators - Generates high-performance documentation websites tailored for software component libraries with built-in search and navigation.
• UI Component API Documentation - Generates structured technical documentation and interactive examples specifically tailored for UI component libraries.
• Source-to-Table Generators - Parses source code to automatically create structured documentation tables and metadata for components.
• Automated API Tables - Automatically parses source code to generate structured documentation tables for components and functions.
• Static Page Rendering - Pre-renders markdown and metadata into static HTML files during the build process to optimize load times.
• Static Site Generators - Transforms markdown files and source code into pre-rendered static HTML pages for hosting.
• Static-Site-Based Documentation - Generates static web interfaces from markdown and source code specifically for software component libraries.
• Site Navigation Generators - Automatically parses content files to generate site navigation structures, including header and sidebar menus.
• Interactive Code Playgrounds - Provides an interactive playground that renders live, runnable code demos of UI components directly in the browser.
• Markdown Documentation Tools - Utilizes a build system that converts markdown files and source code into structured technical guides.
• Static Documentation Generators - Transforms library source code and markdown into navigable, static web-based documentation interfaces.
• Interactive Code Demos - Embeds live, interactive code demos within technical documentation, allowing users to run and modify components in the browser.
• Source Metadata Extraction - Parses component source files to automatically extract metadata for generating documentation tables and property descriptions.
• File-System Based Routing - Automatically maps the directory and file structure of the project to the website's navigation and URL paths.
• Source-Code Parsers - Automatically parses source code to generate documentation tables and property descriptions for components.
• Static Site Generation - Transforms markdown and metadata into independent HTML and JavaScript files for high-performance static hosting.
• Markdown Extensions - Allows the modification of Markdown and HTML syntax trees through custom processing plugins.
• Internationalization & Localization - Implements internationalization and localization workflows to manage multilingual assets and translation strings.
• Theme Customization - Implements a plugin-based theme system that supports internationalization and partial layout overrides.
• Full Text Search - Provides built-in full-text search indexing for titles, body text, and code demos without requiring a backend server.
• Client-Side Indexes - Implements a client-side search index to allow keyword retrieval of documentation without a backend server.
• Build Performance Optimization - Optimizes build performance by utilizing high-performance bundlers to reduce overall compilation time.
• Build Pipeline Plugins - Provides a modular sequence of hooks and plugins to modify build configurations and the final HTML output.
• Monorepo Documentation Sets - Supports developing documentation across multiple sub-packages in a monorepo with integrated source mapping and hot module replacement.
• Source Code Linking - Creates automated links from rendered documentation pages directly to specific line numbers in the version control repository.
• File-Based Locale Partitioning - Implements multi-language support by organizing content and translation strings using locale-based file suffixes.
• Build Lifecycle Hooks - Provides hooks into the compilation and execution lifecycle to modify build configurations and HTML output.
• Plugin Extenders - Supports loading custom plugin files from a theme directory to register additional logic during the build process.
• Global Component Registration - Enables global registration of custom components so they can be called directly within markdown files.
• Monorepo Architectures - Maps sub-package imports to local source files to enable hot module replacement across a monorepo.
• Import Redirections - Maps sub-package imports to local source files to enable hot module replacement across a monorepo.
• Import Redirects - Maps sub-package imports to source files to enable hot module replacement within a monorepo structure.
• Multi-language Support - Provides multi-language support through locale-based file partitioning and a built-in language switcher.
• Convention-Based Route Generation - Automatically creates site routes by mapping the file system to a navigation structure based on naming conventions.
• Site Theming - Allows overriding default layouts and styles using local directories to customize the website's visual appearance.
• Directory-to-Route Mappings - Implements a system that automatically maps the local filesystem directory structure to website URL paths.
• Multi-Language Content Delivery - Implements multi-language documentation using locale-based routing and translation strings.

Star history