Skip to content
/ vvdoc Public

简单 美观 易用的文档站点生成器

License

Notifications You must be signed in to change notification settings

zwmmm/vvdoc

Repository files navigation

vvdoc version

基于 Vite 快速生成文档站点

特性

  1. 开箱即用,快速生成文档站点
  2. 基于vite 启动速度快,编写体验极佳
  3. 支持文档搜索
  4. 自动生成文章目录
  5. 自定义主题

开始使用

yarn create vvdoc
yarn
yarn dev

使用本文档生成的站点

名称 地址
vvModal https://vvmodal.vercel.app/

vvdoc.config.ts

https://github.com/zwmmm/create-vvdoc/blob/main/template/vvdoc.config.ts

自定义入口

当你需要自定义入口,比如全局修改Antd的配置 根目录新增一个 index.tsx

import { ConfigProvider } from 'antd'
import zhCN from 'antd/lib/locale/zh_CN'

export default function (props: any) {
  return (
    <ConfigProvider locale={zhCN} componentSize="small">
      {props.children}
    </ConfigProvider>
  )
}

内置组件

  • Message,
  • Alert,
  • Playground

About

简单 美观 易用的文档站点生成器

Resources

License

Stars

Watchers

Forks

Packages

No packages published