ydoc/docs/examples/index.md

基于 Markdown 的静态站点生成工具

# Demo 介绍

我们为大家提供了一系列 Demo 的在线预览，你可以通过这些 Demo 来了解 YDoc 构建文档的能力，在你构建遇到困惑的时候不妨先看下 Demo 中有没有类似的效果，效仿该效果进行配置即可。

## 本地调试 Demo

首先将 YDoc 项目 clone 到本地：

``` bash
git clone git@github.com:YMFE/ydoc.git
cd ydoc/examples
```

ydoc/examples 目录下有若干 Demo，你可以进入各个 Demo 的目录中执行 ```YDoc build``` 来进行本地调试。

| Demo 名称 | 描述 |
| ------ | ------ |
| [初始化](./init/index.html) | YDoc 一键生成文档的最简版本。 |
| [首页使用 markdown](./homepage/index.html) | 默认主题的首页使用 markdown 的方式 |
| [使用插件](./plugin/index.html) | YDoc 标准插件与 markdown-it 插件的使用 |
| [使用主题](./theme/index.html) | YDoc 使用编辑主题 |