《Effective Java》第三版中文翻译项目教程

《Effective Java》第三版中文翻译项目教程

1. 项目的目录结构及介绍

《Effective Java》第三版中文翻译项目的目录结构如下：

effective-java-3rd-chinese/
├── README.md
├── SUMMARY.md
├── book.json
├── docs/
│   ├── 01.md
│   ├── 02.md
│   ├── ...
│   └── 90.md
└── src/
    └── assets/
        └── images/

目录结构介绍

• README.md: 项目的主介绍文件，包含项目的基本信息和使用说明。
• SUMMARY.md: 书籍的目录结构，列出了所有章节和子章节的链接。
• book.json: 项目的配置文件，用于定义书籍的元数据和构建配置。
• docs/: 存放所有章节内容的文件夹，每个章节对应一个 .md 文件。
• src/: 存放项目资源文件的文件夹，如图片等。
• src/assets/images/: 存放图片资源的文件夹。

2. 项目的启动文件介绍

项目的启动文件主要是 SUMMARY.md 和 README.md。

SUMMARY.md

SUMMARY.md 文件定义了书籍的目录结构，通过链接指向各个章节的内容文件。它是构建书籍导航的关键文件。

README.md

README.md 文件是项目的主介绍文件，包含了项目的基本信息、使用说明和贡献指南。用户在访问项目主页时首先看到的就是这个文件。

3. 项目的配置文件介绍

项目的配置文件是 book.json。

book.json

book.json 文件用于定义书籍的元数据和构建配置。以下是该文件的一个示例内容：

{
    "title": "Effective Java 第三版 中文翻译",
    "author": "sjsdfg",
    "description": "《Effective Java》第三版的中文翻译项目",
    "language": "zh-hans",
    "plugins": [
        "expandable-chapters-small",
        "anchors",
        "github"
    ],
    "pluginsConfig": {
        "github": {
            "url": "https://github.com/sjsdfg/effective-java-3rd-chinese"
        }
    }
}

配置文件介绍

• title: 书籍的标题。
• author: 书籍的作者。
• description: 书籍的描述。
• language: 书籍的语言，这里设置为简体中文。
• plugins: 使用的插件列表，如 expandable-chapters-small、anchors 和 github。
• pluginsConfig: 插件的配置信息，如 github 插件的 URL。

通过这些配置，可以定制书籍的显示效果和功能。