使用 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

相关文章

中文分词jieba库的使用与实景应用(一)

知识星球:https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义: 精确模式(默认模式): 全模式: 搜索引擎模式: paddle 模式(基于深度学习的分词模式): 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取

使用SecondaryNameNode恢复NameNode的数据

1)需求: NameNode进程挂了并且存储的数据也丢失了,如何恢复NameNode 此种方式恢复的数据可能存在小部分数据的丢失。 2)故障模拟 (1)kill -9 NameNode进程 [lytfly@hadoop102 current]$ kill -9 19886 (2)删除NameNode存储的数据(/opt/module/hadoop-3.1.4/data/tmp/dfs/na

Hadoop数据压缩使用介绍

一、压缩原则 (1)运算密集型的Job,少用压缩 (2)IO密集型的Job,多用压缩 二、压缩算法比较 三、压缩位置选择 四、压缩参数配置 1)为了支持多种压缩/解压缩算法,Hadoop引入了编码/解码器 2)要在Hadoop中启用压缩,可以配置如下参数

Makefile简明使用教程

文章目录 规则makefile文件的基本语法:加在命令前的特殊符号:.PHONY伪目标: Makefilev1 直观写法v2 加上中间过程v3 伪目标v4 变量 make 选项-f-n-C Make 是一种流行的构建工具,常用于将源代码转换成可执行文件或者其他形式的输出文件(如库文件、文档等)。Make 可以自动化地执行编译、链接等一系列操作。 规则 makefile文件

使用opencv优化图片(画面变清晰)

文章目录 需求影响照片清晰度的因素 实现降噪测试代码 锐化空间锐化Unsharp Masking频率域锐化对比测试 对比度增强常用算法对比测试 需求 对图像进行优化,使其看起来更清晰,同时保持尺寸不变,通常涉及到图像处理技术如锐化、降噪、对比度增强等 影响照片清晰度的因素 影响照片清晰度的因素有很多,主要可以从以下几个方面来分析 1. 拍摄设备 相机传感器:相机传

pdfmake生成pdf的使用

实际项目中有时会有根据填写的表单数据或者其他格式的数据,将数据自动填充到pdf文件中根据固定模板生成pdf文件的需求 文章目录 利用pdfmake生成pdf文件1.下载安装pdfmake第三方包2.封装生成pdf文件的共用配置3.生成pdf文件的文件模板内容4.调用方法生成pdf 利用pdfmake生成pdf文件 1.下载安装pdfmake第三方包 npm i pdfma

零基础学习Redis(10) -- zset类型命令使用

zset是有序集合,内部除了存储元素外,还会存储一个score,存储在zset中的元素会按照score的大小升序排列,不同元素的score可以重复,score相同的元素会按照元素的字典序排列。 1. zset常用命令 1.1 zadd  zadd key [NX | XX] [GT | LT]   [CH] [INCR] score member [score member ...]

git使用的说明总结

Git使用说明 下载安装(下载地址) macOS: Git - Downloading macOS Windows: Git - Downloading Windows Linux/Unix: Git (git-scm.com) 创建新仓库 本地创建新仓库:创建新文件夹,进入文件夹目录,执行指令 git init ,用以创建新的git 克隆仓库 执行指令用以创建一个本地仓库的

【北交大信息所AI-Max2】使用方法

BJTU信息所集群AI_MAX2使用方法 使用的前提是预约到相应的算力卡,拥有登录权限的账号密码,一般为导师组共用一个。 有浏览器、ssh工具就可以。 1.新建集群Terminal 浏览器登陆10.126.62.75 (如果是1集群把75改成66) 交互式开发 执行器选Terminal 密码随便设一个(需记住) 工作空间:私有数据、全部文件 加速器选GeForce_RTX_2080_Ti

【Linux 从基础到进阶】Ansible自动化运维工具使用

Ansible自动化运维工具使用 Ansible 是一款开源的自动化运维工具,采用无代理架构(agentless),基于 SSH 连接进行管理,具有简单易用、灵活强大、可扩展性高等特点。它广泛用于服务器管理、应用部署、配置管理等任务。本文将介绍 Ansible 的安装、基本使用方法及一些实际运维场景中的应用,旨在帮助运维人员快速上手并熟练运用 Ansible。 1. Ansible的核心概念