如何用gitbook api文档写文档并存到github上

首页 & 开源软件GitBook+Markdown制作精美电子书 一、Gitbook概述 GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 并非关于 Git 的教程。
GitBook支持输出多种文档格式: 静态站点:GitBook默认输出该种格式,生成的静态站点可直接托管搭载Github Pages服务上; PDF:需要安装gitbook-pdf依赖; eBook:需要安装ebook-convert; 单HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程; JSON:一般用于电子书的调试或元数据提取。 使用GitBook制作电子书,必备两个文件:README.md和SUMMARY.md。README.md多为电子书的简介内容,SUMMARY.md用来定义电子书章节结构,如:
同时,GitBook还支持嵌入JavaScript的交互式内容,未来版本会支持Python、Ruby等语言。 二、gitbook的安装 以下是来自gitbook项目页上提供的安装方法:GitBook can be installed from NPM using:
$ npm install gitbook-cli -g
Create the directories and files for a book from its SUMMARY.md file (if existing) using
$ gitbook init
You can serve a repository as a book using:
$ gitbook serve
Or simply build the static website using:
$ gitbook build 三、gitbook的基本规则 Gitbook需要2个基本文件: README.md SUMMARY.md README.md是关于你的书的介绍,而SUMMARY.md中则包含了书目,即章节结构,它的格式大致是:* [第1章](c1.md)
* [第1节](c1s1.md)
* [第2节](c1s2.md)
* [第2章](c2.md) 剩下的东西就很好理解了,你只需要编写相应章节即可。在编辑完README.md和SUMMARY.md后,你可以运行以下命令:$ gitbook serve -p 8080 . Gitbook首先把你的Markdown文件编译为HTML文件,并根据SUMMARY.md生成书的目录。所有生存的文件都保存在当前目录下的一个名为_book的子目录中。完成这些工作后,Gitbook会作为一个HTTP Server运行,并在8080端口监听HTTP请求。 运行以上命令后,打开浏览器,在地址栏输入:http://localhost:8080即可看到你的书页了。 其中位于左侧书目顶部的Introduction一节就编译自README.md,而书目本身自编译自SUMMARY.md。你要在自己的网站上发布新书,只需把_book目录复制到服务器相应目录即可。至此Gitbook的基本用法就介绍完毕。下面简单讨论下Gitbook的其他应用,包括Gitbook的插件、与Github的融合、Gitbook客户端、Gitbook平台,以及Gitbook的问题。 四、Gitbook的插件支持 Gitbook可以生成HTML,因此它支持一些外部的JavaScript文件嵌入到HTML中,例如Google统计、Disqus评论系统等。以下以页面中嵌入Disqus评论为例。 首先是安装Gitbook的Disqus插件。$ npm install gitbook-plugin-disqus 然后建立一个book.json文件,其格式如下:{
"plugins": ["disqus"],
"pluginsConfig": {
"disqus": {
"shortName": "NAME-FROM-DISQUS"
} 把上面的NAME-FROM-DISQUS修改为你在Disqus上的项目名即可。 再次运行命令:$ gitbook serve -p 8080 . 并刷新浏览器,即可看到附加了Disqus评论的页面。 与Github的融合 Gitbook的博客上说Github提供了对Gitbook的特殊支持,但我没有测试。只是依然把源文件保存在Github上,然后用Gitbook去编译。期待Gitbook做的更好。 Gitbook客户端 Gitbook客户端支持Mac、Windows、Linux。我在Mac和Windows简单尝试了这个客户端,总体而言可以用。但也仅仅是可以用而已。你可以在客户端里编辑Markdown文件,并提供一个实时的预览窗口;可以关联到你的Gitbook账户,并把内容同步到gitbook.io,并为你生成PDF等。说句题外话,如果你要Markdown的客户端的话,飞象马克更好用,至少Vim编辑模式你得支持啊。 五、Gitbook的问题 Gitbook网站的访问速度很慢。可以在生成_book目录后,把其中的HTML文件和gitbook子目录(包含字体和js文件等)复制到自己的网站上。 Gitbook提供的push功能不能用。push.gitbook.io这个地址无法访问,不知是否是临时性服务故障。 Gitbook生成PDF的中文字体极其难看。万分期待改进。话说Gitbook生存的HTML上的中文非常漂亮。
本站的发展离不开您的资助,金额随意,欢迎来赏!
分类: 开源软件 Git您可能也喜欢git创建、删除库,分支管理 github上如何删除一个项目(仓库) Linux下Git和GitHub使用 github for windows的使用 centos下git的安装 捐助本站
如您感觉本博客有用,可扫码向本博客捐赠近期文章 利用sshpass获取多台主机的信息 修改CPAN mirror的默认源 更换主板后waiting for device to appear无法启动 CL210 openstack配置 openstack dashborad提示SSL失败解决方法文章归档 文章归档 选择月份 2016年五月 &(2) 2016年四月 &(5) 2016年三月 &(2) 2016年二月 &(2) 2016年一月 &(4) 2015年十二月 &(7) 2015年十一月 &(9) 2015年十月 &(6) 2015年九月 &(7) 2015年八月 &(22) 2015年七月 &(10) 2015年六月 &(15) 2015年五月 &(23) 2015年四月 &(13) 2015年三月 &(22) 2015年二月 &(15) 2015年一月 &(24) 2014年十二月 &(12) 2014年十一月 &(15) 2014年十月 &(19) 2014年九月 &(18) 2014年八月 &(18) 2014年七月 &(20) 2014年六月 &(21) 2014年五月 &(24) 2014年四月 &(11) 2014年三月 &(29) 2014年二月 &(22) 2014年一月 &(22) 2013年十二月 &(24) 2013年十一月 &(20) 2013年十月 &(18) 2013年九月 &(13) 2013年八月 &(15) 2013年七月 &(20) 2013年六月 &(21) 2013年五月 &(19) 2013年四月 &(17) 2013年三月 &(21) 2013年二月 &(17) 2013年一月 &(18) 2012年十二月 &(24) 2012年十一月 &(18) 2012年十月 &(17) 2012年九月 &(17) 2012年八月 &(18) 2012年七月 &(25) 2012年六月 &(36) 2012年五月 &(36) 2012年四月 &(28) 2012年三月 &(46) 2012年二月 &(23) 2012年一月 &(14) 2011年十二月 &(27) 2011年十一月 &(59) 2011年十月 &(19) 2011年九月 &(15) 2011年八月 &(46)使用Gitbook + MarkDown 写技术文档/电子书 | DeveWork
当前位置: &
打破沉默,我来发表评论鸟~1. 安装npm&从 https://nodejs.org/#download 下载node.js(点击绿色的INSTALL),解压./configuremakemake install&成功执行后,npm就被安装好了。2. gitbook 安装npm install -g gitbook-cligitbook -V&查看gitbook是否安装成功。3 安装git下载git&https://code..com/p/msysgit/downloads/list 4 生成sshkey输入 ssh-keygen ,按enter,一直按enter 公钥生成在&C:\Documents and Settings\xxx\.ssh 目录中,找到目录 ,里面有id_rsa.pub文件,用记事本打开,然后把里面的东西 全选复制。并在github上配置sshkey5 github上新建一个: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&:zimingforever/mygitbook.git
git&push&-u&origin&master6 下载gitbookeditor并安装,打开gitbookeitor,FILE-》imoport 找到之前的clone的文件7 左侧table of contents可以增加新的章节或者7 gitbook editor打开后,book-editor confugration可以设置book.json文件8 目录 book-repo setting可以设置远程的git地址,需要更改成http的地址/zimingforever/mygitbook.git,然后设置对应的账号及密码9 每次gitbook eidtor编辑完之后可以点击下右侧的sync按钮,相关的文件就会推到github上10 使用gitbook命令生成对应的html文件c:
cd&C:\Users\xxx\GitBook\Library\Import\
gitbook&build&mygitbook11 将生成好的html文件推到github上c:
cd&C:\Users\xxx\GitBook\Library\Import\mygitbook
git&config&--global&credential.helper&store
git&add&-A
git&commit&-m&'udpatebook'
start&/zimingforever/mygitbook/tree/master/_book请问在windows 环境下 github 项目 如何和 gitbook互相连接呢?
零基础起步目前只安装了python2.7还需要安装什么使用githib么!
两个教程,你看了就懂了
已有帐号?
无法登录?
社交帐号登录

我要回帖

更多关于 git与github区别 的文章

 

随机推荐