diff --git a/README.md b/README.md index 606180aeda..77a9d6c73a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ [![codecov](https://codecov.io/gh/umijs/dumi/branch/master/graph/badge.svg)](https://codecov.io/gh/umijs/dumi) [![NPM version](https://img.shields.io/npm/v/dumi.svg?style=flat)](https://npmjs.org/package/dumi) [![CircleCI](https://circleci.com/gh/umijs/dumi/tree/master.svg?style=svg)](https://circleci.com/gh/umijs/dumi/tree/master) [![GitHub Actions status](https://github.com/umijs/dumi/workflows/Node%20CI/badge.svg)](https://github.com/umijs/dumi) [![NPM downloads](http://img.shields.io/npm/dm/dumi.svg?style=flat)](https://npmjs.org/package/dumi) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/) +## Intro + +A doc tool base on Umi that can help you dev library & write doc. + +### Features + +- 📦 Out of the box, focus on development & documentation +- 🚀 Base on Umi 3, high-performance & extensible +- 📋 Powerful Markdown extensions, support embed demo, external demo & inline demo + ## Usage & Guide To check out live examples and docs, visit [dumi official site](https://d.umijs.org). @@ -15,6 +25,47 @@ $ npm run build -- -w $ npm run dev ``` +## Who is using dumi? + + + + + + + + + +
+ + +
+ UmiJS +
+
+ + +
+ Umi Hooks +
+
+ + +
+ Pro Layout +
+
+ ## Discuss diff --git a/config/config.js b/config/config.js index e5361ffc25..fadeec382d 100644 --- a/config/config.js +++ b/config/config.js @@ -1,6 +1,7 @@ export default { - title: 'Dumi', + title: 'dumi', mode: 'site', + favicon: 'https://img.alicdn.com/tfs/TB1YHEpwUT1gK0jSZFhXXaAtVXa-28-27.svg', menus: { '/guide': [ { diff --git a/docs/index.md b/docs/index.md index 0c96e95aca..aafa5c3adf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ --- -title: 介绍 +title: dumi - 基于 Umi、为组件开发场景而生的文档工具 order: 10 hero: - title: Dumi + title: dumi desc: 基于 Umi、为组件开发场景而生的文档工具 actions: - text: 快速上手