Salvo Website

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

Environment Preparation

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

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

Install dependencies

Use Bun to install project dependencies:

bun install

Project structure

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
• codes_md: Markdown document automatically generated from the codes directory and the SalvoCargo.toml file in the root directory

Tool script description

bun run utils/tool ​​name Run tool

• bun run utils/files2md: Convert all mdx files into one md file (for generating long context for llm)
• bun run utils/gen_code_md2: Markdown document automatically generated by the codes directory and the SalvoCargo.toml file in the root directory, mainly completing:

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

• bun 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

Development Guide

Start the development server:

bun run dev

Build the production version:

bun run build

Preview the production build locally:

bun run preview

Contribution Guide

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!