Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.13 KB

README-en.md

File metadata and controls

29 lines (18 loc) · 1.13 KB

简体中文 | English

Miru Documentation

Contribution

This site is built with starlight. The content of the site is written in MDX and the files are located in the root directory. If you only have minor changes, you can directly make modifications on the GitHub web interface and create a new pull request.

For local development, pnpm is chosen as the project's package manager. You need to use pnpm to install dependencies:

pnpm i
pnpm run dev
pnpm run build
pnpm run start

Please note! After making modifications, make sure to use build and start to check if the build output is correct!

Modifying Text

  • For information about supported Markdown extensions and the ability to use React syntax within Markdown, please refer to the starlight and astro documentation.
  • For rules and recommendations on writing and maintaining documentation content, please refer to the writing guide.

Writing Guide

Things to consider when writing content:

  1. Leave a space between Chinese and English, such as 测试 test 测试.