README

本文档主要用于:

整理前端开发中遇到的各种bug

对一些浏览过、探索过、实践过的前端技术做一些笔记

项目运行

安装项目: gitbook install

本地启动:sh serve

根目录下有个名serve的shell文件,是为了解决gitbook serve热加载出现中断的问题和指定输出路径。

本地启动项目的核心命令是:gitbook serve [--input] [--output] [--port 4000]

--input是需要编译的项目地址。可不传,默认当前根目录下。

--output是编译后的输出路径。可不传,默认_book。指定输出目录为./docs,是因为GitHub Pages的静态网站指定的目录是master 分支下的./docs文件夹。

--port是端口号。可不传,默认4000

生成文件:sh build

项目git push之前,需要sh build更新SUMMARY.md文件。

根目录下有个名build的shell文件。是为了解决自动生成SUMMARY.md时不编译docs目录下的文件和指定输出路径。

生成文件的核心命令是:gitbook build[--input] [--output]

--input是需要编译的项目地址。可不传,默认当前根目录下。

--output是编译后的输出路径。可不传,默认_book。指定输出目录为./docs,是因为GitHub Pages的静态网站指定的目录是master 分支下的./docs文件夹。

本文有两个访问地址

Gitbook.io

Github Page

已知问题

  • Gitbook不支持原生的html、css语法

    GitBook doesn't render plane HTML or CSS so the workaround would be to wrap them into a code block by adding '```'
    We don't plan on supporting plain HTML or CSS I'm afraid
  • Gitbook.com中引入了gitalk做评论插件。目前遇到问题,无法正常显示

    项目引入是基于gitalkmygitalk插件。已向作者提issue,暂未回复。

最后更新于