Skip to content

Commit

Permalink
docs: complete site info & README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeachScript committed Mar 4, 2020
1 parent 9bdf3f9 commit fcc4cac
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 3 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -15,6 +25,47 @@ $ npm run build -- -w
$ npm run dev
```

## Who is using dumi?

<table>
<tbody>
<tr>
<td align="center">
<a target="_blank" href="https://github.com/umijs/umi">
<img
width="32"
src="https://gw.alipayobjects.com/zos/bmw-prod/598d14af-4f1c-497d-b579-5ac42cd4dd1f/k7bjua9c_w132_h130.png"
/>
<br>
<strong>UmiJS</strong>
</a>
</td>
<td align="center">
<a target="_blank" href="https://github.com/umijs/hooks">
<img
width="32"
style="vertical-align: -0.32em; margin-right: 8px;"
src="https://gw.alipayobjects.com/zos/bmw-prod/598d14af-4f1c-497d-b579-5ac42cd4dd1f/k7bjua9c_w132_h130.png"
/>
<br>
<strong>Umi Hooks</strong>
</a>
</td>
<td align="center">
<a target="_blank" href="https://github.com/ant-design/pro-layout">
<img
width="32"
style="vertical-align: -0.32em; margin-right: 8px;"
src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"
/>
<br>
<strong>Pro Layout</strong>
</a>
</td>
</tr>
</tbody>
</table>

## Discuss

<img src="./docs/assets/qrcode.jpg" width="300" />
3 changes: 2 additions & 1 deletion config/config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
export default {
title: 'Dumi',
title: 'dumi',
mode: 'site',
favicon: 'https://img.alicdn.com/tfs/TB1YHEpwUT1gK0jSZFhXXaAtVXa-28-27.svg',
menus: {
'/guide': [
{
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: 介绍
title: dumi - 基于 Umi、为组件开发场景而生的文档工具
order: 10
hero:
title: Dumi
title: dumi
desc: 基于 Umi、为组件开发场景而生的文档工具
actions:
- text: 快速上手
Expand Down

1 comment on commit fcc4cac

@PeachScript
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#94

Please sign in to comment.