02项目结构.md

项目结构

• 文件系统约定

  • init命令自动生成的两个必备文件
    • README.md 书籍引言(前言、简介)
    • SUMMARY.md 目录结构(大纲)
  • 手动生成
    • LANGS.md 多语言书籍
    • GLOSSARY.md 术语表(词汇解释)
    • book.json 配置信息
    • en/ 英文内容目录
    • zh-hans/ 简体中文目录
    • _book/ 输出路径
    • .gitignore、.bookignore、.ignore过滤文件或文件夹
    • 静态文件和图片：SUMMARY没列出的文件，编译时直接复制

• ##目录结构

   	├── book.json
   	├── README.md
   	├── SUMMARY.md
   	├── chapter-1/
   	| ├── README.md
   	| └── something.md
   	└── chapter-2/
   	├── README.md
   	└── something.md
  

  • 作为项目文档

    • 对于软件项目，可用文件夹放置图书内容，只需在book.json文件中指定root配置即可配置book.json

       	{
       		"root": "./docs"
       	}

    • 对应目录结构

       ├── book.json
       └── docs/
       	├── README.md
       	└── SUMMARY.md
      

• _book静态网站

  • index.html语言索引目录
  • search_index.json搜索索引描述
  • gitbook/页面脚本、资源以及样式表
  • en/英文内容页面
  • zh-hans简体中文内容页面

• LANGS.md语言

	[中文](zh-hans/)
	[English](en/)

• GLOSSARY.md术语

  • 术语为二级标题，只支持英文术语
  • 书籍中只要出现术语，GitBook都会为其自动生成索引，指向注释页glossary.html

• SUMMARY.md大纲

  • 格式：章的名称
  • 编辑后，使用$ gitbook init生成对应目录和文件

  a. 小篇幅：

    ```md
    	* [简介](README.md)
    	* [第1章](c1.md)
    		- [第1节](c1s1.md)
    		- [第2节](c1s2.md)
    	* [第2章](c2.md)
    ```
  

  b. 大篇幅

    ```md
    	* [简介](README.md)
    	* [第一章](chapter1/README.md)
    		- [第一节](chapter1/section1.md)
    		- [第二节](chapter1/section2.md)
    	* [第二章](chapter2/README.md)
    		- [第一节](chapter2/section1.md)
    		- [第二节](chapter2/section2.md)
    	* [结束](end/README.md)
    ```
  

  c. 分割

    ```
    	### Part I
    	* [Writing is nice](part1/writing.md)
    	* [GitBook is nice](part1/gitbook.md)
    	### Part II
    	* [We love feedback](part2/feedback_please.md)
    	* [Better tools for authors](part2/better_tools.md)
    ```
  

• 封面

  • 尺寸
    • cover.jpg 1800x2360
    • cover_small.jpg 200x262
  • 好的封面准则：
    • 没有边框
    • 清晰可见的书本标题
    • 任何重要的文本在小版本中可见

• SEO:

  • 文件顶部添加如下格式描述内容，可实现SEO优化

     	---
     	description: 页面描述内容
     	---
    

  • 描述内容不会呈现，而是编译到页面的 meta 标签中。