使用 github, gitbook, markdown 写博客/写书

2023-12-16 19:32

本文主要是介绍使用 github, gitbook, markdown 写博客/写书,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

        Github 是基于 开源代码管理工具 Git 的一个代码托管平台。Gitbook 是一个命令行工具,可以把你的 Markdown 文件汇集成电子书,并提供PDF等多种格式输出。你可以把Gitbook 生成的HTML发布出来,就形成了一个简单的静态网站。Gitbook还有一个同名的平台(gitbook.io),可以发布和销售电子书。Gitbook 其实跟 Git/Github 没啥关系,但可以通过绑定Github 的项目而达到 push Github 时同时更新到 gitbook.io 的效果。

       首先我们需要有个域名,比如之前随手买的一个 fxnotes.net,我们在域名提供商比如 godaddy 上面设置下 DNS 解析服务器,比如 设置为国内的 dnspod:f1g1ns1.dnspod.net   f1g1ns2.dnspod.net 。

       有了域名我们还需要个ip(主机存储空间),如果购买国内云服务器提供商的主机,我们需要做域名备案,很是麻烦(或者买个vps)。对此可以把域名解析到 xxx.github.io(xxx 为 Github 用户名),当然目录就只能存一些静态 HTML 文件了。

现在我们到了 dnspod 控制台,如下图配置,将 www cname 到 xxx.github.io,且设置两条 A 记录到 Github 提供的 ip 上:

此时我们通过浏览器访问 fxnotes.net 会直接访问到 github.io 对应的某台服务器上面去,但Github 还不存在对应的项目,故建立一个 xxx.github.io 的 repo,在 repo 下建一个文件名为 cname 的文件,写上 fxnotes.net,并随便建一个 index.html 写几个字,访问一下,是不是看到了那几个字?

       进一步地,如果我们将搭建一个博客站点,可以使用 jelly or hexo 等博客模版,然后将写好的 markdown 格式文件 push 到 xxx.github.io 某目录

下,这样就可以访问静态博客页面了。

       如果我们想写开源书籍呢?也是类似的,只不过不用搭建博客模版,但需要借助下 gitbook 工具。

比如我们在 github 上建一个 repo WebSecurityLearning,里面分目录,且按 gitbook 的要求写一个 SUMMARY.md,包含了书目即章节结构,大致格

式如下:


SUMMARY.md

This is the summary of my book
* Overview* [overview](Overview/overview.md)
* XSS* [xss](XSS/xss.md)
* SQLI* [sqli](SQLI/SQLI.md)

         接着用 gitbook 生成书籍,需要安装下 gitbook(使用 npm 安装需要先安装 nodejs)。

$ npm install gitbook -g

$ npm install gitbook-cli -g

         把 repo clone 到本地,gitbook build WebSecurityLearning,会发现目录下多了个 _book 目录,里面就是编译好的书,可以将 

_book 改名为 websec,然后将整个目录 push 到 xxx.github.io 目录下,直接访问 fxnotes.net/websec,其中 Introduction 编译自 README.md,而目

录当然是来自 SUMMARY.md 了,如下所示:

        

        这样我们就能在本地写 markdown 文件,然后 push 到 github 做版本维护,用 gitbook 编译 目录,替换 站点目录,更新书籍,

还算是比较方便的。无论写博客还是写文章,如果需要引用图片,需要外链,推荐用七牛云存储来上传本地图片做外链。


注:本文不涉及详细流程、设置和命令,只为大家提供个思路索引,具体动手做一遍就清晰了。




这篇关于使用 github, gitbook, markdown 写博客/写书的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/501628

相关文章

使用Python删除Excel中的行列和单元格示例详解

《使用Python删除Excel中的行列和单元格示例详解》在处理Excel数据时,删除不需要的行、列或单元格是一项常见且必要的操作,本文将使用Python脚本实现对Excel表格的高效自动化处理,感兴... 目录开发环境准备使用 python 删除 Excphpel 表格中的行删除特定行删除空白行删除含指定

深入理解Go语言中二维切片的使用

《深入理解Go语言中二维切片的使用》本文深入讲解了Go语言中二维切片的概念与应用,用于表示矩阵、表格等二维数据结构,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧... 目录引言二维切片的基本概念定义创建二维切片二维切片的操作访问元素修改元素遍历二维切片二维切片的动态调整追加行动态

prometheus如何使用pushgateway监控网路丢包

《prometheus如何使用pushgateway监控网路丢包》:本文主要介绍prometheus如何使用pushgateway监控网路丢包问题,具有很好的参考价值,希望对大家有所帮助,如有错误... 目录监控网路丢包脚本数据图表总结监控网路丢包脚本[root@gtcq-gt-monitor-prome

Python通用唯一标识符模块uuid使用案例详解

《Python通用唯一标识符模块uuid使用案例详解》Pythonuuid模块用于生成128位全局唯一标识符,支持UUID1-5版本,适用于分布式系统、数据库主键等场景,需注意隐私、碰撞概率及存储优... 目录简介核心功能1. UUID版本2. UUID属性3. 命名空间使用场景1. 生成唯一标识符2. 数

SpringBoot中如何使用Assert进行断言校验

《SpringBoot中如何使用Assert进行断言校验》Java提供了内置的assert机制,而Spring框架也提供了更强大的Assert工具类来帮助开发者进行参数校验和状态检查,下... 目录前言一、Java 原生assert简介1.1 使用方式1.2 示例代码1.3 优缺点分析二、Spring Fr

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理;Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window

Ubuntu如何分配​​未使用的空间

《Ubuntu如何分配​​未使用的空间》Ubuntu磁盘空间不足,实际未分配空间8.2G因LVM卷组名称格式差异(双破折号误写)导致无法扩展,确认正确卷组名后,使用lvextend和resize2fs... 目录1:原因2:操作3:报错5:解决问题:确认卷组名称​6:再次操作7:验证扩展是否成功8:问题已解