Gitbook文档中如何添加外部链接内容块?
Gitbook 实现卡片式外部链接块的配置方法
你截图里的块级外部链接卡片,Gitbook默认确实不支持直接生成,根据你使用的Gitbook版本,选对应方案配置即可:
方案1:官方新版GitBook(当前在线托管版/新版CLI工具)
新版GitBook内置了自定义链接块组件,不需要额外安装插件,直接在Markdown文件中使用以下块语法即可:
{% link href="替换为目标外部链接地址", title="替换为卡片显示的标题文本", description="替换为卡片的说明描述文本", image="替换为卡片显示的图标/缩略图地址" /%}
将对应字段替换为你自己的内容后,保存文档构建就会自动渲染成和截图一致的卡片样式,官方平台托管的文档不需要额外配置外链白名单。
方案2:旧版GitBook / HonKit(本地构建的v3.x及更早版本)
老版本GitBook以及后续分叉维护的HonKit没有内置该组件,需要通过插件实现,步骤如下:
- 在项目根目录的
book.json配置文件中添加插件声明:
{ "plugins": ["linkcard"], "pluginsConfig": { "linkcard": { "defaultFavicon": true } } }
- 在项目根目录执行安装命令:
gitbook install,HonKit用户执行npx honkit install - 回到Markdown文档中,使用以下语法插入链接卡片即可:
{% linkcard "替换为目标外部链接地址" "替换为卡片标题" "替换为卡片描述文本" %}
如果不想使用插件,也可以直接在Markdown中编写自定义HTML代码实现卡片结构,再在项目的自定义CSS文件中编写对应样式,这种方法全版本通用,样式可以自由调整匹配你需要的效果。
注意:普通的Markdown行内链接语法[链接文本](链接地址)只会渲染成行内文本链接,无法生成块级卡片效果。
内容的提问来源于stack exchange,提问作者Mert Deveci
相关产品推荐
相关产品推荐

