当前位置:   article > 正文

基于GitBook + Typora + Git的文档托管解决方案_gitbook gitlab托管

gitbook gitlab托管

Gitbook

Github托管访问地址:https://xiexieni1992.github.io/gitbook

介绍

​ 这是一个基于GitBook + Typora + Git的文档托管解决方案!

​1、目录结构

├─docs // github 静态资源文件夹
│  ├─.gitignore
│  ├─gitbook
│  │  ├─fonts
│  │  │  └─fontawesome
│  │  ├─gitbook-plugin-fontsettings
│  │  ├─gitbook-plugin-highlight
│  │  ├─gitbook-plugin-lunr
│  │  ├─gitbook-plugin-search
│  │  ├─gitbook-plugin-sharing
│  │  └─images
│  └─src
│      ├─Todo01
│      ├─Todo02
│      ├─Todo03
│      └─Todo04
├─src
│  ├─Todo01
│  ├─Todo02
│  ├─Todo03
│  └─Todo04
└─_book // 本地服务器文件夹
    ├─.gitignore
    ├─gitbook
    │  ├─fonts
    │  │  └─fontawesome
    │  ├─gitbook-plugin-fontsettings
    │  ├─gitbook-plugin-highlight
    │  ├─gitbook-plugin-livereload
    │  ├─gitbook-plugin-lunr
    │  ├─gitbook-plugin-search
    │  ├─gitbook-plugin-sharing
    │  └─images
    └─src // 源文件夹
        ├─Todo01
        ├─Todo02
        ├─Todo03
        └─Todo04
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38

2、使用gitbook

2.1 安装并初始化gitbook

npm install -g gitbook-cli
gitbook init
  • 1
  • 2

执行完后。会有以下两个文件

README.md —— 书籍的介绍写在这个文件里
SUMMARY.md —— 书籍的目录结构在这里配置
  • 1
  • 2

2.2 Typora 编写SUMMARY.md

* [前言](README.md)
* 正文
  * [段落](src/Todo01/README.md)
  * [段落](src/Todo02/README.md)
  * [段落](src/Todo03/README.md)
  * [段落](src/Todo04/README.md)
* [后记]
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

保存后,命令行工具运行以下命令:

gitbook init
  • 1

GitBook 会查找 SUMMARY.md 文件中描述的目录和文件,如果没有则会将其创建。

2.3 本地运行gitbook

gitbook serve --port 8088
  • 1

执行 gitbook serve 来预览这本书籍,出现 Serving book on http://localhost:8088,浏览器进行本地访问。

2.4 构建gitbook

gitbook build ./ docs
  • 1

2.5 其它格式

gitbook pdf ./ ./xxx.pdf
gitbook epub ./ ./xxx.epub
gitbook mobi ./ ./xxx.mobi
  • 1
  • 2
  • 3

3、Git托管静态网站

进入github=>Setting=>GitHub Pages=>Source

master branch /docs dolder
  • 1

结束:Demo source

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/773296
推荐阅读
相关标签
  

闽ICP备14008679号