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

🌟 A doc template can assist you to develop libraries & write docs.
https://github.com/umijs/dumi-template

dumi dumi-demo react template umijs

Last synced: 3 months ago
JSON representation

🌟 A doc template can assist you to develop libraries & write docs.

• Host: GitHub
• URL: https://github.com/umijs/dumi-template
• Owner: umijs
• License: mit
• Created: 2020-12-24T02:29:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-13T13:20:04.000Z (over 2 years ago)
• Last Synced: 2024-08-13T09:45:00.549Z (3 months ago)
• Topics: dumi, dumi-demo, react, template, umijs
• Language: TypeScript
• Homepage: https://umijs.github.io/dumi-template/
• Size: 645 KB
• Stars: 98
• Watchers: 6
• Forks: 150
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌟 Dumi Template

A doc template can assist you to develop libraries & write docs.

English | [简体中文](./README.zh-CN.md)

## 🚀 How to use?

![](https://gw.alipayobjects.com/zos/bmw-prod/91791904-cdde-4408-959d-72fd0c9049b1/kj80x6lv_w1918_h352.png)

## ✨ Online preview

https://umijs.github.io/dumi-template/

## 📒 Catalog Introduction

```

├── docs                   Component documentation

│   ├── index.md           Home page

│   └── **.**              Site Directory Document

├── src                    Component home directory

│   ├── index.ts           Component registration

│   └── Foo                Component development

├── .eslintrc.js           eslint config

├── .fatherrc.ts           father config

├── .umirc.ts              dumi config

└── tsconfig.json          typescript config

```

The rest of the documents can be consulted by yourself.

## 🤖 Command introduction

| Name                    | Description               | Remarks                                                                                                            |

| ----------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------ |

| `npm run start`         | Project begining          | Document usage [dumi](https://github.com/umijs/dumi), component development and documentation development together |

| `npm run test`          | Component test            | -                                                                                                                  |

| `npm run test:coverage` | Code coverage review      | -                                                                                                                  |

| `npm run prettier`      | Code prettier             | -                                                                                                                  |

| `npm run build`         | Component packaging       | Use [father](https://github.com/umijs/father)                                                                      |

| `npm run release`       | Component package release | -                                                                                                                  |

| `npm run docs:build`    | Document packaging        | -                                                                                                                  |

| `npm run docs:deploy`   | Document release          | The default is to use GitHub Pages                                                                                 |

| `npm run deploy`        | Document package release  | -                                                                                                                  |

### README Badge

Using dumi ? Add a README badge to show it off: [![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

```

[![dumi](https://img.shields.io/badge/docs%20by-dumi-blue)](https://github.com/umijs/dumi)

```

## Discuss group