TensorFlow 한글 문서 프로젝트 사용 가이드

TensorFlow 한글 문서 프로젝트 사용 가이드

1. 项目目录结构及介绍

TensorFlow 한글 문서 프로젝트의 目录结构如下：

tensorflow-kr/
├── g3doc/
├── LICENSE
├── README.md
├── SUMMARY.md
├── book.json
├── progress.md

目录结构介绍

• g3doc/: 该目录包含了TensorFlow官方文档的韩文翻译文件。
• LICENSE: 项目使用的开源许可证文件，本项目使用Apache-2.0许可证。
• README.md: 项目的介绍文件，包含了项目的概述、参与方式等信息。
• SUMMARY.md: 项目的目录文件，用于生成GitBook的目录结构。
• book.json: GitBook的配置文件，用于自定义GitBook的显示和功能。
• progress.md: 翻译进度文件，记录了各个部分的翻译进度。

2. 项目启动文件介绍

TensorFlow 한글 문서 프로젝트没有特定的启动文件，因为这是一个文档翻译项目，主要通过GitBook来展示翻译后的文档。

GitBook启动方式

1. 克隆项目到本地：

   git clone https://github.com/tensorflowkorea/tensorflow-kr.git
   

2. 进入项目目录：

   cd tensorflow-kr
   

3. 安装GitBook CLI（如果尚未安装）：

   npm install gitbook-cli -g
   

4. 启动GitBook服务：

   gitbook serve
   

5. 打开浏览器访问 http://localhost:4000 查看翻译后的文档。

3. 项目配置文件介绍

book.json

book.json 是GitBook的配置文件，用于自定义GitBook的显示和功能。以下是一个示例配置：

{
  "title": "TensorFlow 한글 문서",
  "description": "TensorFlow 官方文档的韩文翻译",
  "author": "TensorFlow Korea",
  "language": "ko",
  "plugins": [
    "expandable-chapters",
    "search",
    "sharing"
  ],
  "pluginsConfig": {
    "sharing": {
      "facebook": true,
      "twitter": true
    }
  }
}

配置文件介绍

• title: 文档的标题。
• description: 文档的描述。
• author: 文档的作者或维护者。
• language: 文档的语言，这里设置为韩文（ko）。
• plugins: 启用的GitBook插件，例如 expandable-chapters 用于展开章节，search 用于搜索功能，sharing 用于分享功能。
• pluginsConfig: 插件的配置，例如 sharing 插件的配置，启用了Facebook和Twitter的分享功能。

通过以上配置，可以自定义GitBook的显示和功能，使其更符合项目的需求。