This is the official documentation project of Salvo, built on Rspress.

This project uses pnpm as the package manager and runtime environment. Before you begin, make sure pnpm is installed:

# Install pnpm
curl -fsSL https://get.pnpm.io/install.sh | sh -

Use pnpm to install project dependencies:

pnpm install

This project contains the following main directories:

• docs: Document source file directory, containing all official Salvo documentation
• utils: Utility script directory, various scripts for assisting document generation and maintenance
• codes: Sample code in the Salvo library repository, copied directly from the Salvo main repository

pnpm run utils/tool ​​name Run tool

1. Convert sample code (such as .rs files) to .mdx format
2. Replace Salvo and other third-party library dependencies in cargo.toml with specific version numbers

• pnpm run utils/translation_tool: Translation tool,

1. Set the environment variable OPENAI_API_KEY Currently using deepseek V3 for translation.
2. The md5 of the translation file will be used as a comment and attached to the translated document, and the translated document will be skipped during translation. Please check the tool notes before using the tool

After using the translation tool, please check that the page rendering is as expected and there are no errors

Start the development server:

pnpm run dev

Build the production version:

pnpm run build

Preview the production build locally:

pnpm run preview

We welcome every developer interested in Salvo to participate in the improvement and improvement of the documentation. You can contribute in the following ways:

• Submit bug fixes or document updates
• Improve the content and structure of existing documents

Before submitting a contribution, please make sure your changes meet the style and standards of the project.

Thank you for your support of the Salvo project!