# dumisource

**Repository Path**: victor1998/dumisource

## Basic Information

- **Project Name**: dumisource
- **Description**: dumi source 
- **Primary Language**: 其他
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-25
- **Last Updated**: 2024-08-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: dumisource

## README

## 手动初始化

### 安装

建立一个空文件夹，然后在文件夹下执行以下命令进行安装：

```
$ npm i dumi -D
```

### 开始写文档

dumi 默认会自动搜寻 `docs`、`src`（或各 lerna 包下的 `src`）目录下的 markdown 文件，我们先来一篇最简单的文档：

```
$ mkdir src && echo '# Hello dumi!' > src/index.md
```

然后执行 `dumi dev`，文档将会呈现在你眼前：

![快速上手 - 图1](https://static.sitestack.cn/projects/dumi-1.x/79bb2735332860ab5dda19628fd90345.png)

### 写个 Demo 试试看

dumi 会将 `jsx/tsx` 代码块当做 React Component 进行渲染然后放入 Demo 包裹器中，我们将 `src/index.md` 修改为如下内容：

```
# Hello dumi! ```jsximport React from 'react'; export default () => <h2>First Demo</h2>;```
```

保存之后我们的第一个 Demo 就运行起来了：

![快速上手 - 图2](https://static.sitestack.cn/projects/dumi-1.x/c7bc4d05a97fc2a2bf23bced0d3faebe.png)

是不是非常简单？但写 Demo 易写好 Demo 难，关于写 Demo 这件事，dumi 有些理念和原则，也想与你分享一下：[dumi 的 Demo 理念](https://www.bookstack.cn/read/dumi-1.x/$guide-guide-demo-principle)。