gitbook介绍,使用,打包

本文详细介绍了Gitbook的使用,包括gitbook的介绍、安装、创建项目、设置目录层级结构、实用插件的运用以及如何打包Gitbook项目。通过自定义样式、配置目录结构和使用插件如代码高亮,提升阅读体验。同时,文章指出gitbook 3.x.x版本的打包问题及其解决方案。
摘要由CSDN通过智能技术生成

目录:

一. gitbook介绍

1、gitbook说明

  • GitBook 使用的markdown语法 在此基础上做了一些 写作便利性的加强
  • Markdown 是一种轻量级的「标记语言」,优点在于
    • 专注你的文字内容而不是排版样式。
    • 轻松的导出 HTML、PDF 和本身的 .md 文件。
    • 纯文本内容,兼容所有的文本编辑器与字处理软件。
    • 可读,直观。适合所有人的写作语言。

2、安装gitbook

npm install gitbook-cli -g   # 安装gitbook
gitbook  help                # 查看gitbook帮助信息
gitbook  -V                  # 查看gitbook版本信息

3、创建一个gitbook项目

C:\Users\tom>  cd C:\aa\test-book            # 进入要进行书写的空文件夹
C:\aa\test-book>  gitbook init               # 初始化文件夹
C:\aa\test-book>  gitbook serve --port 80    # 在本地80端口运行gitbook这个服务
# 注访问:http://localhost:80

4、设置gitbook样式

book.json :在C:\aa\test-book中创建插件配置:

{
   
    "language": "zh-hans",
    "plugins": [
        "livereload",
        "highlight",
        "search",
        "lunr",
        "-sharing",
        "fontsettings",
        "theme-default"
    ],


    "styles": {
   
        "website": "styles/website.css"
    }

}

styles/website.css :在C:\aa\test-book清除默认链接样式:

.gitbook-link {
   
    display: none!important;
}

二. 设置目录层级结构

1、说明

  • test-book 目录下的 SUMMARY.md 文件是 gitbook init 自动生成的 你也可以自己创建
    这个markdown文件决定了你文档的目录结构
  • SUMMARY.md 就是一个markdown文件 当中内容遵循如下格式,星号 空格 方括号 圆括号【 *
    前言
    • 1)星号:的缩进代表所在条目的层级结构,四个空格为一个层级,相当于是一个链接
    • 2)方括号:中是链接的名字
    • 3)圆括号:中是一个文件里面是实际内容
    • 4)默认的 README.md 是你的说明文件 你可以将文档的说明内容 在此文件中编辑 对应一本书的前言 或者是序言

2、使用举例

1)创建对应的文件目录结构

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值