2019独角兽企业重金招聘Python工程师标准>>>

1. 安装npm,从网站 下载node.js源代码 https://nodejs.org/#download

解压
./configure
make
make install

成功执行后,npm就被安装好了。

2. gitbook 安装

npm install -g gitbook-cli
gitbook -V

查看gitbook是否安装成功。

3 安装git

https://code.google.com/p/msysgit/downloads/list

4 生成sshkey

输入 ssh-keygen ,按enter,一直按enter 公钥生成在 C:\Documents and Settings\xxx\.ssh 目录中,找到目录 ,里面有id_rsa.pub文件,用记事本打开,然后把里面的东西 全选复制。

并在github上配置sshkey

5 下载gitbookeditor并安装

https://www.gitbook.com/editor/windows

6 github上新建一个项目

git@github.com:zimingforever/mygitbook.git

并把这个项目直接clone到gitbook的文件目录下面C:\Users\XXX\GitBook\Library\Import\mygitbook

初始化文件夹

echo # mygitbook >> README.md
git initgit add README.md
git commit -m "first commit"
git remote add origin git@github.com:zimingforever/mygitbook.git
git push -u origin master

7 打开gitbookeitor,FILE-》imoport 找到之前的clone的文件

左侧table of contents可以增加新的章节或者文章

8 gitbook editor打开后,book-editor confugration可以设置book.json文件

9 目录 book-repo setting可以设置远程的git地址,需要更改成http的地址https://github.com/zimingforever/mygitbook.git,然后设置对应的账号及密码

10 每次gitbook eidtor编辑完之后可以点击下右侧的sync按钮,相关的文件就会推到github上

11 使用gitbook命令生成对应的html文件

c:cd C:\Users\xxx\GitBook\Library\Import\gitbook build mygitbook

12 将生成好的html文件推到github上

c:cd C:\Users\xxx\GitBook\Library\Import\mygitbookgit config --global credential.helper storegit add -Agit commit -m 'udpatebook'git pushstart https://github.com/zimingforever/mygitbook/tree/master/_book

13 GITBOOK editor的使用界面

14 使用githubpage来打开对应的地址

http://htmlpreview.github.io/

15 生成地址为 http://htmlpreview.github.io/?https://github.com/zimingforever/mygitbook/blob/master/_book/index.html 直接访问即可

转载于:https://my.oschina.net/zimingforever/blog/596532

如何用gitbook写文档并存到github上相关推荐

  1. .net编写抽奖的文档_使用开源文档工具docsify,用写博客的姿势写文档

    前提 ❝ 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 ❞ 「docsify」是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBoo ...

  2. GitBook 告别文档共享烦恼

    GitBook GitBook 提供以下功能. 支持 markdown 语法 自动构建文档网站 丰富的插件来拓展网站,比如:搜索,代码高亮等 支持 git 进行文档项目管理 什么是 GitBook G ...

  3. 为什么程序员都不写文档?

    ‍‍‍ ‍ [CSDN 编者按]对于程序员来说文档可能是他最大的软肋.一些被称之为高手的程序员,往往是文档方面的处理会偏弱.不管这个程序员是在大公司.还在小公司.不管程序是写文档的.还是不写文档的,大 ...

  4. 如何理解写文档这件事情 ?

    目录 目录 前言 对公司而言 标准化流程 最佳实践 对自己而言 前言 个人札记, 写下对 写文档 这件事情的理解, 欢迎讨论. 对公司而言 文档系统是 标准化流程 和 最佳实践 的温床. 我们不仅是在 ...

  5. 程序员都讨厌写文档?这4个工具让你事半功倍

    长按识别上方二维码,关注公众号:后端面试那些事 回复"报告",获取你的GitHub年度报告! 对于一般的程序员来说,花费数小时来创建代码或修改现有代码只是一天工作中的一部分,简而言 ...

  6. python如何读取公共盘的文档_如何使用 Sphinx 给 Python 代码写文档 | Linux 中国

    最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka Python 代码可以在源码中包含文档.这种方式默认依靠 docstring ...

  7. 从程序员到项目经理(二十九):怎样写文档

    在软件项目中,文档既是一项的重要成果,也是项目管 理的有力工具.通过文档,可以稳定.明确的传达信息,实现项目内的有效沟通.所以写文档对项目经理来说,是一项必备的技能. 然而很多项目经理害怕写文档,似乎 ...

  8. python代码_如何使用 Sphinx 给 Python 代码写文档

    最好将文档作为开发过程的一部分.Sphinx 加上 Tox,让文档可以轻松书写,并且外观漂亮.-- Moshe Zadka(作者) Python 代码可以在源码中包含文档.这种方式默认依靠 docst ...

  9. 解决写文档对于图片边框的强迫症

    1. 写文档的困扰 在写文档进行配图时,很多时候图片是白色背景的,会导致文章中的图片区域附近有大量空白的感觉,强迫症患者很难受. 目前语雀做的是很好的,可以给图片加边框或者阴影,而一些文档博客平台(C ...

最新文章

  1. Spring加载properties文件的两种方式
  2. 被声明为已否决 解决方法
  3. 使用ln -s解决库冲突的问题
  4. 日常小记录json文件(json.load()、json.loads()、json.dump()、json.dumps())
  5. 数据结构(十六)多源最短路径
  6. m-qam matlab,基于matlab的M_QAM通信系统仿真.doc
  7. 100以内奇数的平方和
  8. 计算机桌面设置上时间表,桌面时钟怎么设置-电脑显示时间不对 怎么校准电脑右下角显示的时间?...
  9. 语音合成论文优选STYLER: Style Modeling with Rapidity and Robustness via Speech Decomposition for Expressive
  10. c# 贪婪匹配 html,C#正则表达式之贪婪模式
  11. 献给面试学生 关键字const是什么意思 ESP(译者:Embedded Systems Programming) --Dan Saks概括了const的所有用法
  12. python 会计师_成为会计师所需的9项关键的技能
  13. C#VB.NET 合并PDF页面
  14. 新唐51单片机----挖坑
  15. 钉钉企业内部应用获取登录用户信息
  16. oc指针和c语言区别,C 指针和OC 对象之间的转换方法
  17. C# 之 Ocelot 使用
  18. 程序员必备的画图工具
  19. mysql连接 xorm_golang 使用xorm操作mysql
  20. android 自定义录像机,android 手机录屏,最简单的 3 种方法

热门文章

  1. 【淘宝技术这十年】,读后总结篇 转载
  2. 一位Erlang程序猿的自白
  3. scrum 11.28
  4. apache+php+mysq环境详细l配置
  5. linux之我常用的20条命令(之二)
  6. [转]Windows 性能监视器工具-perfmon
  7. HTML中td元素的nowrap属性
  8. eclipse项目如何变成web项目_Eclipse中将Java项目转换成Web项目的方法
  9. 计算机毕业设计中Python Django 框架目录结构简介
  10. thinkphp6 加载第三方类库_thinkphp中第三方类引入问题