gitbook教程

原创已于 2023-05-15 18:21:12 修改 · 192 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#git #github

收录于

于 2023-05-15 18:12:56 首次发布

软件安装专栏收录该内容

2 篇文章

订阅专栏

该文指导如何使用git从远程服务器克隆GitBook项目，安装Node.js（推荐10.x版本），通过gitbook-cli安装和配置GitBook。在安装过程中可能遇到的报错需注释JS代码。GitBook的目录结构包括静态HTML、图片、npm模块等。SUMMARY.md定义目录结构，使用Markdown编写内容，可以使用gitbookbuild生成静态文件，gitbookserve进行本地开发预览。

git clone git@123.57.88.121:root/gitbook.git
安装node【推荐10.版本的版本高会报错。报错需要注释几段js代码】
Node.js 官网下载安装即可
安装gitbook
1.npm install gitbook-cli -g
2.gitbook —version 【提示找不到：注意添加环境变量】

执行安装需要的：gitbook install

文件目录结构
gitbook
—_book 静态html文件。gitbook build/serve生成
—assets/images 图片存放位置
—node_moudules 通过book.json配置的插件
—供应商管理.md markdown文件。具体页面需要在这里编辑
—book.json 用于配置 GitBook 的项目文件
—README.md 书籍的介绍和简介

    --SUMMARY.md        章节目录结构

开发说明:
目录结构在SUMMARY.md定义。然后去根目录下创建对应的文件结构
创建好后执行gitbook build生成静态文件
gitbook serve 本地开发用。会启动一个http://127.0.0.1:4000/ 来查看页面

注意文档使用Markdown写的。Markdown没有官网下面是我找的几个语法参考网址
Markdown 官方语法规则：Daring Fireball: Markdown Syntax Documentation
GitHub Flavored Markdown（GFM）语法规则：GitHub Flavored Markdown Spec
Markdown 中文文档：Markdown 中文文档