项目简介

《Elasticsearch权威指南》一书的学习笔记。

本书按照GitBook格式编写,可以使用gitbook-cli工具生成本地HTML预览。

即:

  • README.md文件会被编译为对应目录下的index.html
  • /SUMMARY.md文件会被编译为目录

本书约定

本书编写过程中遵循以下规范:

  • 所有文件及路径统统使用小写ASCII字符,不得出现任何中文字符以及特殊字符(如',",>,<,?,*等有特殊含义的字符)
  • 如有特殊字符,一律使用_字符替换。如标题为I'm fine.的文档,重命名为i_m_fine.md
  • 单词之间使用_字符连接。如getting_started
  • 目录层级关系与文件夹层级关系保持一致。如目录层级chapter01/stage01/summary对应的文件路径为chapter01/stage01/summary.md
  • 如果层级本身有内容,应放入对应文件夹的README.md中。如chapter01/stage01/对应的文件路径为chapter01/stage01/README.md

举个例子。比如这样的目录结构:

$ tree .
.
├── 01_getting_started
│   ├── README.md
│   └── 01_you_know_for_search
│       ├── installing_and_running_elasticsearch.md
│       └── README.md
├── README.md
└── SUMMARY.md

那么对应的SUMMARY.md应为:

* [Getting Started](01_getting_started/README.md)
    * [You know, For search](01_getting_started/01_you_know_for_search/README.md)
        * [Installing and Running Elasticsearch](01_getting_started/01_you_know_for_search/installing_and_running_elasticsearch.md)

results matching ""

    No results matching ""