SoybeanAdmin Documentation

简介

这是 SoybeanAdmin 项目的官方文档。本文档使用 VitePress 构建，提供多语言支持（中文和日语）。

SoybeanAdmin 仓库

• NaiveUI 版本:

  • 预览地址
  • Github 仓库
  • Gitee 仓库
  • Gitcode 仓库

• AntDesignVue 版本:

  • 预览地址
  • Github 仓库
  • Gitee 仓库
  • Gitcode 仓库

• ElementPlus 版本:

  • 预览地址
  • Github 仓库
  • Gitee 仓库
  • Gitcode 仓库

• 旧版:

  • 预览地址
  • Github 仓库
  • Gitee 仓库
  • Gitcode 仓库

• 文档仓库:

  • Github 仓库
  • Gitee 仓库
  • Gitcode 仓库

克隆

# github
git clone https://github.com/soybeanjs/soybean-admin-docs.git
# gitee
git clone https://gitee.com/honghuangdc/soybean-admin-docs.git
# gitcode
git clone https://gitcode.com/soybeanjs/soybean-admin-docs.git

安装

# 安装依赖
pnpm install

开发

# 启动开发服务器
pnpm dev

构建

# 构建文档
pnpm build

预览构建结果

# 预览构建后的文档
pnpm preview

项目结构

• .vitepress - VitePress 配置和主题文件
  • config.ts - 主要配置文件
  • locales/ - 多语言支持文件
• src - 文档内容
  • zh/ - 中文文档
  • jp/ - 日语文档
  • guide/ - 指南
  • tutorial/ - 教程
  • awesome/ - 精选资源
  • standard/ - 规范
  • faq/ - 常见问题
  • recommend/ - 推荐内容

贡献指南

欢迎为 SoybeanAdmin 文档做出贡献，请参考以下步骤：

1. Fork 本仓库
2. 创建您的特性分支 (git checkout -b feature/amazing-feature)
3. 提交您的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开一个 Pull Request

许可证

本项目使用 MIT 许可证 进行许可。