- 22
- 0
- 约3.42千字
- 约 10页
- 2021-06-07 发布于湖南
- 举报
Gitbook浅玩:如何发布开源的需求文档?
本文主要围绕 GitBook 的安装、使用、集成、书籍发布四个方面来论述。
GitBook 是一项致力于文档编制、数码写作和出版的新型、简单的解决方案。它不仅提供了简单且强大的电子书创建工具 GitBook,同时还提供了在线电子书制作平台 GitB。
GitBook?is where you create, write and organize documentation and books with your team.
简单点说,如果你想自己写开源的需求文档玩也打算让其他人加入一起参与创作,就可以尝试选择 Gitbook 了。
为什么要将需求文档开源呢?日常工作中,复杂程度很高的业务需求(如医疗行业)单个人或者单个组织的知识范围和深度难以分析透彻,众人拾柴火焰高,将需求文档转变为众创的形式,就极有可能在一段时间的演化后输出品质极高的需求文档,人人编写,人人使用,这也是互联网开放开源精神的体现!
很多东西就是玩出来的,如果你不满不同行业的知识壁垒和乐于分享你的知识,同时,你也打算自己改变这种现状,这篇文章就值得一看。(预计花费8分钟阅读完,消化并熟练掌握需2小时)
本文主要围绕 GitBook 的安装,使用,集成,书籍发布四个方面来论述,还会分享一些Gitbook 书籍资源,文末还会发起开源的编写不同行业的需求文档的活动。
Let’s play~
安装
首先,你需要安装? node.js?,以便使用“命令提示符” (Mac 系统打开“终端”)来安装 Gitbook 。
安装只需要一步就能实现,简单移动。
$ npm install gitbook -g
由于网络的原因,安装的时间可能会较长一些,请耐心等待直到安装完成。
安装完成后可以输入以下命令,以查看 GitBook 版本的方式检查是否安装成功:
$ gitbook -V
使用
基本的用法并不复杂,一般来说需要两步:
使用?gitbook init?初始化书籍目录
使用?gitbook serve?编译书籍
下面使用一个简单直观的示例来介绍 Gitbook 的基本使用方法。
gitbook init
首先,创建如下目录结构:
$ tree book/book/├── README.md└── SUMMARY.md
0 directories, 2 files
README.md 和 SUMMARY.md 是两个必须文件,README.md 是对书籍的简单介绍:
$ dog book/README.md# README
This is a book powered by [GitBook](/GitbookIO/gitbook).
SUMMARY.md 是书籍的目录结构。内容如下:
$ dog book/SUMMARY.md# SUMMARY
* [Chapter1](chapter1/README.md)* [Section1.1](chapter1/section1.1.md)* [Section1.2](chapter1/section1.2.md)* [Chapter2](chapter2/README.md)
创建了这两个文件后,使用?gitbook init,它会为我们创建 SUMMARY.md 中的目录结构。
$ cd book$ gitbook init$ tree.├── README.md├── SUMMARY.md├── chapter1│ ├── README.md│ ├── section1.1.md│ └── section1.2.md└── chapter2└── README.md
2 directories, 6 files
gitbook serve
书籍目录结构创建完成以后,就可以使用?gitbook serve?来编译和预览书籍了:
$ gitbook serveLive reload server started on port: 35729Press CTRL+C to quit …
info: 7 plugins are installedinfo: loading plugin “livereload”… OKinfo: loading plugin “highlight”… OKinfo: loading plugin “search”… OKinfo: loading plugin “lunr”… OKinfo: loading plugin “sharing”… OKinfo: loading plugin “fontsettings”… OKinfo: loading plugin “theme-default”…
您可能关注的文档
最近下载
- CECS304-2011 建筑用金属面绝热夹芯板安装及验收规程.docx VIP
- 基于大数据的电池新材料设计.docx VIP
- XF_T 87-2023 防火刨花板XF_T 87-2023 防火刨花板.docx VIP
- 2026年新能源大数据行业数据安全报告.docx VIP
- 春节加班奖励报告通知模板.docx VIP
- T_SXCAS 043-2025 公路路面基层煤矸石细集料应用技术标准.docx VIP
- DB61_T 2005-2025 道路多孔水泥混凝土路面施工技术规范.docx VIP
- DB11_T 1322.81-2025 安全生产等级评定技术规范 第81部分:歌舞娱乐场所.pdf VIP
- DB51_T 3317-2025 高寒草地生态修复碳汇核算技术规范.pdf VIP
- DB51_T 3312-2025 四川省斜坡地质灾害隐患风险详查技术指南.pdf VIP
原创力文档

文档评论(0)