少于 1 分钟阅读

GitBook - Where software teams break knowledge silos. 打破知识孤岛. GitBook 帮助你向用户发布更优雅的文档,并集中团队的知识以助于更好的合作

前言

你是否阅读过在线文档? 你是否看过阮一峰的《ECMAScript 6 入门教程》? 你是否想要写一个专栏并发布在网络上?

GitBook 是什么

GitBook 是一个现代化文档平台,可以用于团队分享产品文档、内部知识沉淀或者 API 文档

我们通过创建一个简单且迄今为止非常强大的服务以帮助团队更高效地分享他们的知识

我的使命是为每个人创建一个对用户友好并且方便协作的产品,去通过文档的创建、编辑和分享知识

GitBook 能做什么

异步协作

团队创建美观的文档和内部知识分享

异步协作

版本管理和实时发布

丰富的改动历史记录和分支内容

版本管理和实时发布

知识分享

公开和私有部署均可,也可以分享一个私密链接用于他人访问

知识分享

享受在线文档

优雅的编辑器和富内容块

享受在线文档

在上下文中进行讨论

提供有价值的反馈和方向

在上下文中进行讨论

自定义配置

通过自定义空间匹配自己的品牌

自定义配置

特点

强大、简洁的编辑体验

通过高效的编辑器授权团队成员共同完成文档,无需代码基础,无需设计界面。

  • 支持 Markdown
  • 支持代码片段
  • 高效的快捷键
  • 强大的嵌入功能

低门槛分享美观的文档

自动设计界面,可以在任何地方发布你的文档。如果使用 GitHub, 一键同步 markdown 文件并自动生成文档

  • 自定义域名
  • 访问者权限控制
  • 高级的品牌宣传
  • GitHub 和 GitLab 同步

团队协作

在经过组织的独立的空间中集中进行团队知识沉淀和协作,以助于提高效率。让每个人都在同一页面上,在正确的时间找到你想要的东西。

  • 版本控制
  • 搜索
  • 评论
  • 异步协作

已经合作的客户

很多企业和开源项目已经在 GitBook 共享文档

Adobe Mobile SDKs Powershell Electron Forge LearnRxJs

主要使用场景

  • 产品文档 - 为你的用户提供好看的文档,无需代码和设计
  • 知识沉底 - 团队知识沉淀的共享空间
  • 个人项目 - 个人笔记博客等内容输出
  • API 文档 - 与 API 集成,为用户提供完美的洞察力
  • 开源项目 - 为 GitHub 仓库同步好看的文档,永久免费
  • 其他场景 - GitBook 为所有类型的内容和合作提供一个有弹性平台

快速开始

这篇文章将总结开始使用 GitBook 所有需要了解的基础知识。你将能发现所有设置组织空间内容的最佳实践和提示

创建账号并浏览 GitBook

GitBook 充满了可能性,注册并选择你将和谁一起使用。我们将根据你的倾向为你创建合适的示例和计划。

控件

开始组织你创意的项目。把它比喻为一本虚拟的书籍,你们可以同时在这里开始写文章

专栏

专栏是一组由相同的具体主体,团队或目的组建的集合。专栏不仅仅是组合,你可以在组织成员共享的基础上设置访问权限,或者以专栏的方式自定义并发布一组多种多样的空间

空间的组织结构

树形结构

空间的页面以树形结构的方式在编辑内容的左侧展现,可以通过新增页面、子页面嵌套和创建页面组等方式管理空间结构,以方便结构化和可视化地拆分页面到逻辑组合中

树形结构

标题

GitBook 提供三级标题以助于组织页面结构。树形结构代表空间文章的大纲并可以导航到你的页面

内容编辑

GitBook 内容编辑主要有两个特点:在线编辑改动历史

在线实时编辑

一旦创建新空间, GitBook 将默认解锁在线编辑功能。这就意味着任何有编辑权限或者更高权限的人都能够立即编辑内容。

在线实时编辑

改动历史

改动历史将维持一个保护的主要内容分支,通过改动历史管理任何改动。改动历史是可以提交和合并的空间分支。任何有编辑或更高权限的人都可以提交改动历史。任何有检验或更高权限的人都可以根本改动请求。

改动历史

团队合作

通过邀请成员到组织中进行团队合作

邀请成员

创建组织以后就可以邀请成员。通过赋予权限、为不同空间创建团队、给指定人管理员策略来定义角色

角色说明

GitBook 预设一些成员角色,成员既可以是预设角色也可以不是。已邀请成员会被设置为默认角色,这些角色可以被覆盖或者继承自专栏或空间。

团队成员分组

分组是一个管理组织成员很好的方式。如果你有没有组织成员,可以把他们分组。任何成员都可以分入多个小组,小组可以设置比组织成员更大的权限

讨论

写作不再是一个人的体验。成员可以提供有价值的反馈,并校验其他人的工作。可以针对于文章内容、也可以针对于空间和改动历史上下文进行讨论

自定义内容

  • 字体
  • 颜色
  • 主题

参考

GitBook Documentation