0
点赞
收藏
分享

微信扫一扫

[笔记]Github+Gitbook+Github Page+Typora搭建电子书

程序员漫画编程 2022-02-26 阅读 68

文章目录

前期

  • nodejs
  • npm
  • gitbook
  • github仓库
  • Typora MarkDown 编辑器

环境搭建

nodejs安装:NodeJS可在其官网(https://nodejs.org/zh-cn/)
npn安装gitbook:

npm install gitbook-cli -g

gitbook安装summer插件自动生成SUMMARY.md:

npm install -g gitbook-summary

开始gitbook搭建

创建文件夹

在这里插入图片描述
主要是创建以下目录:

  • docs:存放md文件
    在这里插入图片描述

以下目录是生成的:

  • _book:是生成html的目标目录
  • node_modules:插件安装目录
  • assert:是相关图片存放的目录

创建book.json

以下为模板(包括插件,和配置信息)

{
  "plugins": [
    "collapsible-menu",
    "anchor-navigation-ex",
    "tbfed-pagefooter",
    "disqus",
    "summary", 
    "toggle-chapters", 
    "theme-comscore",
    "book-summary-scroll-position-saver",
    "expandable-chapters-small",
    "code",
    "copy-code-button"
  ],
  "title": "Shiver Book",
  "description": "Shiver Book",
  "author": "Shiver Book",
  "language": "zh-hans",
  "root": "./docs/",
  "links": {
    "sidebar": {
      "GitHub": "https://github.com/ShiverZm",
      "个人博客": "http://www.shiver.fun"
    }
  },
  "sharing": {
    "facebook": true,
    "twitter": true,
    "weibo": true,
    "qq": true,
    "all": [
      "douban",
      "google",
      "qzone",
      "linkedin"
    ]
  },
  "pluginsConfig": {
    "tbfed-pagefooter": {
      "copyright": "Copyright &copy ershouche-FE 2019",
      "modify_label": "文件修订时间:",
      "modify_format": "YYYY-MM-DD HH:mm:ss"
    },
    "disqus": {
      "shortName": "gitbookuse"
    }
  }
}

命令

初始化文件夹

生成README.md和SUMMARY.md

gitbook init

根据目录生成SUMMARY.md

sm book

安装book.json列出的插件

gitbook install

生成HTML

gitbook build

启动服务

gitbook serve

访问localhost:4000即可

开始github

创建仓库

上传book文件夹到主分支

_book目录上传到其他分支

设置github page

开始github action

创建.workflow/main.yml文件

创建环境变量token

举报

相关推荐

0 条评论