Salvo 文档项目

这是Salvo的官方文档项目，基于Rspress构建。

环境准备

本项目使用Bun作为包管理器和运行时环境。在开始之前，请确保已安装Bun：

# 安装Bun
curl -fsSL https://bun.sh/install | bash

安装依赖

使用Bun安装项目依赖：

bun install

项目结构

本项目包含以下主要目录：

• docs: 文档源文件目录，包含所有Salvo的官方文档内容
• utils: 实用工具脚本目录，用于辅助文档生成和维护的各种脚本
• codes: Salvo库仓库中的示例代码，直接从Salvo主仓库复制而来
• codes_md: 由codes目录和根目录的SalvoCargo.toml文件自动生成的Markdown文档

工具脚本说明

bun run utils/工具名称 运行工具

• bun run utils/files2md: 将所有mdx文件转换为成一个md文件（为llm生成长上下文使用）
• bun run utils/gen_code_md2: 由codes目录和根目录的SalvoCargo.toml文件自动生成的Markdown文档，主要完成：
  1. 将示例代码（如.rs文件）转换为.mdx格式
  2. 将cargo.toml中的Salvo和其他第三方库依赖替换为具体版本号
• bun run utils/translation_tool: 翻译工具， 1.设置环境变量OPENAI_API_KEY 目前使用deepseek V3 进行翻译。 2. 会根据翻译文件的md5 作为注释，附加到翻译后的文档中，翻译时跳过已翻译的文档。 使用工具前请查看工具注释 使用翻译工具后请检查，页面渲染符合预期，无报错

开发指南

启动开发服务器：

bun run dev

构建生产版本：

bun run build

本地预览生产构建：

bun run preview

贡献指南

我们欢迎每一位对Salvo感兴趣的开发者参与文档的改进和完善。您可以通过以下方式贡献：

• 提交错误修复或文档更新
• 改进现有文档的内容和结构

提交贡献前，请确保您的更改符合项目的风格和标准。

感谢您对Salvo项目的支持！