Rust 秘典中文翻译项目结构及使用说明

Rust 秘典中文翻译项目结构及使用说明

nomicon-zh-Hans Rust 死灵书简体中文翻译 项目地址: https://gitcode.com/gh_mirrors/no/nomicon-zh-Hans

1. 项目目录结构介绍

nomicon-zh-Hans/
├── .github/              # GitHub 工作流目录
│   └── workflows/        # 工作流配置文件
├── src/                  # 源文件目录，包含翻译内容
│   └── ...               # 具体翻译文件
├── theme/                # 主题文件目录，用于自定义 mdBook 主题
├── .gitignore            # Git 忽略文件列表
├── .gitmodules           # Git 子模块配置文件
├── LICENSE-APACHE        # Apache 许可证文件
├── LICENSE-MIT           # MIT 许可证文件
├── README.md             # 项目说明文件
├── book.toml             # mdBook 配置文件
├── build.sh              # 构建脚本
└── ...                   # 其他辅助文件

• .github/workflows/: 包含了项目的持续集成和部署流程。
• src/: 项目的主要内容，包含了 Rust 秘典的中文翻译文件。
• theme/: 存放自定义的 mdBook 主题文件。
• .gitignore: 指定 Git 忽略跟踪的文件和目录。
• .gitmodules: 如果项目包含子模块，该文件用于配置子模块。
• LICENSE-APACHE 和 LICENSE-MIT: 分别是 Apache 和 MIT 许可证文件，用于声明项目的开源协议。
• README.md: 项目说明文件，介绍了项目的基本信息和如何使用。
• book.toml: mdBook 配置文件，定义了书籍的元数据和构建选项。
• build.sh: 构建脚本，用于构建项目文档。

2. 项目的启动文件介绍

项目的启动主要是通过 build.sh 脚本实现的。这个脚本会调用 mdBook 工具来构建书籍。以下是 build.sh 的内容：

#!/bin/bash

# 构建书籍
mdbook build

# 如果指定了 --open 参数，则在默认浏览器中打开书籍
if [[ "$1" == "--open" ]]; then
    xdg-open book/index.html
fi

要启动项目并查看结果，可以在项目根目录下执行以下命令：

./build.sh --open

这将会构建项目并将结果在默认的网页浏览器中打开。

3. 项目的配置文件介绍

项目的配置主要通过 book.toml 文件进行。以下是 book.toml 的基本结构：

[book]
title = "Rust 秘典"
description = "高级 Unsafe Rust 编程的黑科技指南"
language = "zh-CN"

[output.html]
theme = "theme"

[output]
[output.search]
language = "zh-CN"

• [book]: 包含书籍的基本信息，如标题、描述和语言。
• [output.html]: 定义 HTML 输出的设置，例如使用的主题。
• [output.search]: 配置搜索功能，这里指定了搜索语言为中文。

通过修改 book.toml 文件，可以定制书籍的许多方面，如添加新的章节、修改样式等。

nomicon-zh-Hans Rust 死灵书简体中文翻译 项目地址: https://gitcode.com/gh_mirrors/no/nomicon-zh-Hans