Palpo Website

Palpo offical website base 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 Palpo documentation
• utils: Utility script directory, various scripts for assisting document generation and maintenance

Tool script description

bun run utils/tool ​​name Run tool

• bun run utils/files2md: Convert all mdx files into an md file (for llm to generate long context)
• bun run utils/gen_code_md2: Markdown document automatically generated by the codes directory and the PalpoCargo.toml file in the root directory, mainly completing:
  1. Convert sample code (such as .rs files) to .mdx format
  2. Replace Palpo 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 comments before using the tool After using the translation tool, please check that the page rendering is as expected and there is no error

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 Palpo to participate in the improvement and improvement of the document. You can contribute by:

• Submitting bug fixes or documentation updates
• Improving the content and structure of existing documentation

Before submitting a contribution, please make sure your changes adhere to the project's style and standards.

Thank you for supporting the Palpo project!