命令行gitbook的基本使用

gitbook使用教程

什么是gitbook

是一个命令行工具,使用git和github和markdown构建文版
可以输出网站,

1. 安装

要求安装node.js 最好在v.4.0.0 以上
系统是windows,linux,unix,macos

$ npm install gitbook-cli -g
# girbook-cli 是一个管理插件,安装girbook所有工具

2. 使用:

 $ gitbook init   # 创建一本书
 $ gitbook serve  # 开启一本书的网站服务
 $ gitbook build   # 创建一本书的基本服务-静态网站书

目录结构

gitbook使用的目录结构简单,markdown /asciidoc 可以装换为html,多种书籍的结构有些不同。

     book.json 文件    存储配置数据
     readme.md 文件    你书中的前沿介绍
     summsry.md 文件   目录
     Glossary.md 文件  词汇术语表

静态文件和图像

a static file is a file that is not listed in the SUMMARY.md all static files, unless ignored ,are copeied to the output.

忽略的文件和文件夹

gitbook 将读取文件 .gitignore, .bookignore 以及 .ignore 文件以及获得的文件和文件夹跳过,列表,这些文件中的格式,遵循一下相同的约定。

            # this is a commment
            # ignore the file test.md
              test.md

            # Ignore everything in the dictory “bin”
              bin/*

项目与子目录的整合

就是可以把 整本书嵌入到项目中。

页面和摘要

gitbook 使用了一个summer.md 文件来定义书中的章节和子章节的结构,该summary.md 文件用于生成书籍的目录格式 summary.md 只是一个链列表,链接的表示标题用作章节的标题,链接的,目标是该章节的文件的路径。

将一个嵌套列表添加到父章节将会创建子章节。

简单例子
    # summary

    * [part i ](part1/readme.md)
       * [writing is nice] (part1/ writing.md)
       * [ gitbook is  nice ](part1/ gitbook.md)
    * [part ii](part2/readme.md)
       * [we love feedbask](part2/feedback_please.md)
       * [better tools for authors](part2/better_tools.md)
使用锚
    # Summary

    ### Part I

    * [Part I](part1/README.md)
        * [Writing is nice](part1/README.md#writing)
        * [GitBook is nice](part1/README.md#gitbook)
    * [Part II](part2/README.md)
        * [We love feedback](part2/README.md#feedback)
        * [Better tools for authors](part2/README.md#tools)
设置(json后者能否)

https://toolchain.gitbook.com/config.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值