Dumi Template

Overview

Dumi Template is a documentation template that is designed to assist in the development of libraries and writing documentation. It is available in both English and Simplified Chinese. The template provides an easy way to create and preview documentation online, and includes various commands for project setup, testing, code coverage review, code formatting, component packaging, and documentation packaging and release. The template also offers the option to add a README badge to showcase the use of Dumi.

Features

• Documentation template for library development and writing docs
• Online preview functionality
• Various commands for project setup, testing, code coverage review, code formatting, and packaging and releasing components and documentation
• README badge option to showcase the use of Dumi

Installation

To install and use the Dumi Template, follow these steps:

1. Clone the repository:

git clone https://github.com/umijs/dumi-template.git

2. Install the necessary dependencies:

cd dumi-template
npm install

3. Start the project:

npm run start

4. Use the various commands mentioned above for different tasks such as testing, code formatting, component packaging, and documentation packaging and release.

Summary

Dumi Template is a versatile documentation template that provides a convenient way to develop libraries and write documentation. It offers online preview functionality, various commands for different tasks, and the option to add a README badge to showcase the use of Dumi. With easy installation steps, the template is a useful tool for developers and writers looking to create comprehensive and well-documented libraries.