美文网首页
尝试用gitbook整理组件文档

尝试用gitbook整理组件文档

作者: 一万次番茄炒蛋 | 来源:发表于2020-04-24 16:38 被阅读0次

最近在用gitBook整理团队里的组件文档,目前已整理完毕,以一份类似book的形式来展示和存储,视觉上看还是不错的。

页面展示如下:

文档展示

页面也可以满足日常的搜索功能,也可以跳转,展开目录等,还有不少gitbook的插件供我们使用。

gitbook简介

gitbook其实在我的理解上就是一个使用git操作的markdown合集,他可以将所有md文件整合成一本书。

gitbook常用的几个简单操作命令

npm install gitbook-cli -g   安装gitbook npm

gitbook install 安装插件

gitbook build  构建成Html文件,默认在_book目录下

gitbook serve  启动服务,会生成一个本地地址进行浏览

gitbook --help 获取更多指令,一般以上的几个就满足日常操作需求了


顺便一提编辑工具GitBook Editor

之前有用过GitBook Editor 这个,可以直接编辑预览,还是挺方便的,但是下载资源需要网上另外找。

该软件可以直接创建book,并且在book里创建目录,编辑。

GitBook Editor 编辑页面

操作页面看着也是比较可视化的,编辑完book,可以设置仓库地址,直接save后上传,等于做了一遍commit和push。

当然Typora也还是挺香的。

相关文章

  • 尝试用gitbook整理组件文档

    最近在用gitBook整理团队里的组件文档,目前已整理完毕,以一份类似book的形式来展示和存储,视觉上看还是不错...

  • GitBook 使用教程

    GitBook 使用教程 背景 生成接口文档 GitBook 简介 GitBook 官网 GitBook 文档 G...

  • 005 GitBook 搭建使用教程

    GitBook 简介 GitBook 官网 GitBook 文档 GitBook 准备工作 安装 Node.js ...

  • gitbook

    目前 gitbook 提供三类文档: Book 文档,API 文档和 FAQ 文档。 gitbook 生成电子书主...

  • 游戏测试用例-设计步骤

    游戏测试用例设计步骤需求文档分析>功能模块划分>测试用例编写>测试用例整理与维护 需求文档分析文档阅读功能细节沟通...

  • gitbook

    gitbook使用文档

  • 类似GitBook的在线文档创作平台

    1 Gitbook 对于在线文档创作平台,当然还是首推GitBook GitBook为免费用户提供 10个空间(可...

  • Gitbook 本地搭建

    中文文档:http://gitbook.hushuang.me/setup.html 由于Gitbook的Edit...

  • GitBook

    gitbook官网文档gitbook编辑器 安装gitbook很简单,前提是需要先安装 NodeJS(V4.0及以...

  • Django 1.10中文文档:第一个应用 part 2

    已经同步到gitbook,想阅读的请转到gitbook: Django 1.10 中文文档 This tutori...

网友评论

      本文标题:尝试用gitbook整理组件文档

      本文链接:https://www.haomeiwen.com/subject/lbfitxtx.html