1 min read

《Steem 指南》近期文稿编写遇到的几个问题

原文链接: steemit, cnsteem, busy, chainbb, steemdb, steemd, busy, markdown

This post is a contribution to the open source project Steem Handbook. Details could be found in the post Steem Handbook Calls for Support.

最近,《Steem 指南》的 GitHub 项目收到了很多 PR。我合并后,却发现没法顺利编译成书,需要花时间去找 bug,而这两天比较忙,书稿就一直没更新。今天集中处理了一下,把问题汇总在这里。有的我已经手动修改了,有的还没改,烦请涉案人自己修改一下,更新到项目里为盼。

1. 几处插图,作者用的是网上的图片链接,而编译成书要求必须是本地图片。

红色部分是作者原文,绿色是我修改的。解释一下就是,先把超级链接的图片下载下来,然后按章节编号来改名,并保存到项目里的 images 文件夹,最后用相对链接的方式插到文稿里。

2. 标题脚注,这个怪我,事先没说清楚。

标题末尾,花括号可要可不要。如果要的话,加在标题行的末尾;如果标题后面有脚注,那么花括号要放在脚注后面。

再次解释一下花括号,有两个用处:一是为了交叉引用时自动编号,可是大家一般都不使用交叉引用;二是为了让该章节的网址可读性更强,可是大家一般不在乎。所以,不必加花括号。

3. @ 前要多个反斜杠 \。

这个属于特殊要求,因为编译书稿用的软件会把 @ 符号做特殊处理,所以要用斜杠来阻止这种特殊处理。

4. 冗余格式。

WeChat Image_20180228224701.png

上面这截图,红色是原文,为啥加了个超级链接?我给删了

5. 标题里不必手动编号。

WeChat Image_20180228224731.jpg

上面这个截图,因为原文用了三个#号,所以转换成书时就成了三级标题,并且添加了自动编号。但是读这段文字的话,会发现没必要手动编号,而且作为标题来讲文字有些长。其实,用个加粗和列表格式就够了,不必列为标题。

上面说的脚注、插图、交叉引用等,都不属于markdown的基础语法,所以平时用不到,但是要编成书就得用到了。大家不熟悉没关系,以后接触多了就习惯了。

辛苦各位志愿者了!

相关链接: