DUTManual

大工人的一站式生存指南

贡献指南

本项目使用 Astro 和 Starlight 构建。文档内容使用 Markdown 和 MDX 编写。

文档规范

• 请在 src/content/docs 目录下创建和修改你的 Markdown 文档。
• 建议编写文档时参考中文排版指南。可以使用 VSCode 的 Prettier 插件自动格式化文档。
• 所有文件的文件名都应该是简短的英文，并使用 kebab-case 命名法。使用中文会导致较长的 URL 链接。
• 图片请放置在 src/assets/images 内，Astro 会自动处理和压缩。引用时直接使用相对路径即可，例如 ![image](../../../assets/images/image.jpg)。
• commit 消息不做强制要求，但请尽量使用有意义的 commit 消息，并尽量与其他人的风格保持一致。

组件用法

import { Aside } from "@astrojs/starlight/components";

<Aside>这是一条提示信息。</Aside>

更多组件和用法请参阅 使用组件 | Starlight。

本地预览

您需要首先安装 Node.js 环境。

本项目使用 npm 作为包管理器。在项目根目录下运行以下命令安装依赖：

npm install

最后，运行以下命令启动本地服务器：

npm run dev

特别鸣谢

以及屏幕前的您！