美文网首页我爱编程
GitBook 简单使用

GitBook 简单使用

作者: hnscdg | 来源:发表于2018-05-17 16:59 被阅读0次

    Gitbook 是基于 Node.js 的命令行工具,用来创建漂亮的电子书,它使用 Markdown 或 AsciiDoc 语法来撰写内容,用 Git 进行版本控制,且可以托管在 Github 上。Gitbook 可以将作品编译成网站、 PDF、 ePub 和 MOBI 等多重格式。

    如果你不擅长自己搭建 gitbook 环境,还可以使用 gitbook.com 在线服务来创建和托管你的作品,他们还提供了基于桌面的 编辑器

    如何使用

    首先在全局安装 gitbook 客户端工具:

    $ npm install gitbook-cli -g
    
    

    然后在你的作品目录中创建两个必需的文件 README.md 和 SUMMARY.md,README.md 是作品的介绍,SUMMARY.md 是作品的目录结构,里面要包含一个章节标题和文件索引的列表:

    # Summary
    
    This is the summary of my book.
    
    * [section 1](section1/README.md)
        * [example 1](section1/example1.md)
        * [example 2](section1/example2.md)
    * [section 2](section2/README.md)
        * [example 1](section2/example1.md)
    
    

    根据 SUMMARY.md 的目录结构初始化各个章节文件:

    $ gitbook init
    
    

    运行服务,在编辑内容后实时预览:

    $ gitbook serve
    
    

    服务器启动后,浏览器打开 http://localhost:4000 查看,撰写完后可以生成静态网站用来发布:

    $ gitbook build
    

    使用插件

    Gitbook 本身功能丰富,但同时可以使用插件来进行个性化定制。 Gitbook 插件 里已经有100多个插件,可以在 book.json 文件的 pluginspluginsConfig 字段添加插件及相关配置,添加后别忘了进行安装。

    // book.json
    {
      "title": "Webpack 中文指南",
      "description": "Webpack 是当下最热门的前端资源模块化管理和打包工具,本书大部分内容翻译自 Webpack 官网。",
      "language": "zh",
      "plugins": [
        "disqus",
        "github",
        "editlink",
        "prism",
        "-highlight",
        "baidu",
        "splitter",
        "sitemap"
      ],
      "pluginsConfig": {
        "disqus": {
          "shortName": "webpack-handbook"
        },
        "github": {
          "url": "https://github.com/zhaoda/webpack-handbook"
        },
        "editlink": {
          "base": "https://github.com/zhaoda/webpack-handbook/blob/master/content",
          "label": "编辑本页"
        },
        "baidu": {
            "token": "a9787f0ab45d5e237bab522431d0a7ec"
        },
        "sitemap": {
            "hostname": "http://zhaoda.net/"
        }
      }
    }
    
    
    # 安装插件
    $ gitbook install ./
    

    相关文章

      网友评论

        本文标题:GitBook 简单使用

        本文链接:https://www.haomeiwen.com/subject/pixidftx.html