---
title: 文档配置
description: 快速配置文档结构
---

## name

用于配置文档名称，唯一标识，通常用于组件库文档中，用来指示当前文档分类，名称为发布到`npm`的包名。

``` javascript
{
  name:'@ldesign/desktop-next'
}
```

## title

配置文档左上角的标题名称，一般不推荐过长的文字，通常配置该项之后同时还需要指定`logo`的值。

``` javascript
{
  title: 'LDesign'
}
```

## logo

文档系统的logo图标，常配合`title`一起组成一个完整的logo，推荐使用`svg`图片。

``` javascript
{
  logo: 'https://yun.swimly.cn/source/ldesign/favicon.svg'
}
```

## isComponent

设置当前文档是否作为组件库文档，当为`true`的时候右上角会自动渲染所有组件库及公共包的选择器，否则仅保留最基础的功能。

``` javascript
{
  isComponent: true
}
```

## versions

开启文档版本管理，可设置多个文档版本进行快速切换，具体配置如下所示：

``` javascript
versions: [{
  path: 'https://wuhan.yxybb.com/ldesign/desktop-next',
  name: '0.6.0'
}, {
  path: 'https://wuhan.yxybb.com/ldesign/desktop-next/0.5',
  name: '0.5.11'
}]
```

## currentVersion

当前文档的版本号，用于标识当前文档版本信息，切记设置的版本号一定在`versions`数组中。

``` javascript
{
  currentVersion: '0.6.0'
}
```

## git

设置文档的`git`仓库地址，通常用于组件库文档，可实现快速跳转到代码仓库

``` javascript
{
  git: 'https://git.longrise.cn:6285/ldesign/ldesign-desktop-next'
}
```

## npm

用于组件库（库）文档中，填写已发布的`npm`地址，例如：`http://npm.longrise.cn:6286/`

``` javascript
{
  npm: 'http://npm.longrise.cn:6286/'
}
```

## tips

设置文档顶部的提示信息，当设置多条的时候会自动轮播，具体请参考如下：

``` javascript
{
  tips: [{
    title: 'ldesign-desktop-next发布新版啦，请注意查看更新日志。',
    url: 'https://www.baidu.com',
  }, {
    title: 'ldesign-desktop-next发布新版啦，请注意查看更新日志。111',
    url: 'https://www.baidu.com',
  }],
}
```

## menus

配置文档左侧的菜单，目前最大仅支持`2`层菜单，具体请参考：

``` javascript
{
  title: '开始',
  type: 'doc',
  path: '/start',
  children: [
    {
      title: '快速开始',
      path: 'getting-started',
      component: () => import('@/getting-started.md')
    },
    {
      title: '配置',
      path: 'setting',
      component: () => import('@/setting.md')
    },
  ],
},
```