ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

将Markdown发布成gitbook

2021-10-27 11:01:07  阅读:280  来源: 互联网

标签:md Markdown 文件 gitbook 发布 README 安装 目录


Markdown是很好的文档编写方式,编辑完之后可以发布成浏览器可以访问的页面,方便阅读和分享。

方法很简单,列一下具体步骤

1、安装Node.js 下载地址https://nodejs.org/en/ 2、安装gitbook 参考https://www.npmjs.com/package/gitbook
npm install gitbook-cli -g
gitbook -V  #可以查看是否安装成功,会自动安装GitBook

  

3、使用gitbook 新建一个文件夹,打开CMD后进入这个目录,执行下面命令初始化,会生成两个文件: README.md(书籍的介绍在这个文件里) SUMMARY.md(书籍的目录结构在这里配置)
gitbook init

SUMMARY.md 文件参考示例:

中括号里是这个目录的名字,小括号里是路径 等编写完目录后文件后再次执行 gitbook init,会自动查找SUMMARY.md中写的目录和文件,如果不存在会自动创建。
# Summary

* [Introduction](README.md)
* [第一章](part1/README.md)
    * [第一节](part1/1.md)
    * [第二节](part1/2.md)
* [第二章](part2/README.md)

4、发布

发布后可以通过IP和端口访问,默认端口4000,也可以生成静态页面后自己部署

gitbook serve
# 生成静态页面
gitbook build

还可以通过安装插件实现自动生成目录、导出PDF等功能

5、报错问题 如果安装GitBook时报错 0 可以将错误信息中的那个AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js文件修改,注释掉下图的三行试试 0  

标签:md,Markdown,文件,gitbook,发布,README,安装,目录
来源: https://www.cnblogs.com/yanh0606/p/15469497.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有