返回介绍

锚点

发布于 2024-10-04 20:04:44 字数 3536 浏览 0 评论 0 收藏 0

Gitbook 插件:用来显示锚点,快速跳转到某个地方。

Anchors

添加 Github 风格的锚点样式

[!TIP|style:flat|iconVisibility:hidden|labelVisibility:hidden] npm install gitbook-plugin-anchors

https://github.com/rlmv/gitbook-plugin-anchors

"plugins" : [ "anchors" ]

下面的这个插件是增强版,功能比较全。

Anchor-navigation-ex

添加Toc到侧边悬浮导航以及回到顶部按钮。需要注意以下两点:

本插件只会提取 h1,h2,h3 标签作为悬浮导航

[!TIP|style:flat|iconVisibility:hidden|labelVisibility:hidden] npm install gitbook-plugin-anchor-navigation-ex

这个版本的配置项非常多,也有中文版的说明:

https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex

只有按照以下顺序嵌套才会被提取

# h1
## h2
### h3

必须要以 h1 开始,直接写 h2 不会被提取 ## h2

{
    "plugins": [
        "anchor-navigation-ex"
    ],
    "pluginsConfig": {
        "anchor-navigation-ex": {
            "showLevel": false,
            "showGoTop": true,
            "isRewritePageTitle": true,
            "isShowTocTitleIcon": true,
            "tocLevel1Icon": "fa fa-hand-o-right",
            "tocLevel2Icon": "fa fa-hand-o-right",
            "tocLevel3Icon": "fa fa-hand-o-right"
        }
    }
}

效果:

Anchor-navigation-ex

该主题启用了此插件,可以用插件的配置"showGoTop": true实现 返回顶部 功能。

back-to-top-button

如果想单独实现 返回顶部 功能,可以使用该插件。

[!TIP|style:flat|iconVisibility:hidden|labelVisibility:hidden] npm install gitbook-plugin-back-to-top-button

{
    "plugins": [
        "back-to-top-button"
    ]
}

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文