gitbook 插件:文本隐藏

简介: gitbook 插件:文本隐藏

文本隐藏

文章目录

文本隐藏

1. accordion 折叠模块

1.1 安装

1.2 配置

1.3 效果

2. click-reveal 插件

2.1 安装

2.2 配置

2.3 效果

3. hide-element 插件

3.1 安装

3.2 配置

3.3 效果

4. sectionx 插件

4.1 安装

4.2 配置

4.3 添加按钮,控制部分可见性

4.4 混合使用

1. accordion 折叠模块

折叠模块, 别名叫accordion。可以实现将内容隐藏起来,外部显示模块标题和显示箭头,点击箭头可显示里面的内容。

在文章中对主体内容进行细化说明较长,又不是文章核心逻辑时,可以隐藏细化说明部分,有需要时可以由读者决定是否阅读该部分细化说明。

1.1 安装

npm i gitbook-plugin-accordion

1.2 配置

{
  "plugins": ["accordion"]
}

在文章中使用标记对内容进行折叠

1.3 效果

%accordion% 模块标题 %accordion%
- 内容部分第1行
- 内容部分第2行
- 内容部分第3行
- 内容部分第4行
- 内容部分第5行
- 内容部分第6行
- 内容部分第7行
- 内容部分第8行
- 内容部分第9行
%/accordion%

2. click-reveal 插件

click-reveal 点击显示 默认隐藏,点击可显示。

2.1 安装

npm i gitbook-plugin-click-reveal

2.2 配置

{
    "plugins": [
        "click-reveal"
    ]
}

使用方式,markdown

{% reveal %}
要被隐藏的内容
{% endreveal %}

默认显示的文字是 Click to show , 使用自定义显示文字

{% reveal text="点击显示" %}
要被隐藏的内容
{% endreveal %}

支持html语法

<div class="click_reveal">
    <span> 点击显示 </span>
    <div><pre><code>隐藏的文字</code></pre></div>
</div>

2.3 效果

b41705914ab149ed906428aa9032a946.gif

3. hide-element 插件

hide-element 插件:可以隐藏不想看到的元素,比如导航栏中 Published by GitBook

3.1 安装

npm i gitbook-plugin-hide-element

3.2 配置

{
    "plugins": [
        "hide-element"
    ],
    "pluginsConfig": {
        "hide-element": {
            "elements": [".gitbook-link"]
        }
    }
}

3.3 效果

默认可以移除最左侧下方的提示信息:

Published with GitBook
本书使用 Gitbook 发布

4. sectionx 插件

将页面分块显示 用于将页面分成多个部分,并添加按钮以允许读者控制每个部分的可见性。 下面有个更好的折叠模块功能accordion

4.1 安装

npm i gitbook-plugin-sectionx

4.2 配置

{
    "plugins": [
           "sectionx"
    ]
}

容分块:

在 .md 文件中定义一个部分(就是插入下面的字段)。 markdown中示例代码:

<!--sec data-title="标题2" data-id="section0" data-show=true ces-->
内容部分2;
<!--endsec-->

这里只采用三个参数,其他参数如下所示:

1671263958379.png

4.3 添加按钮,控制部分可见性

通过在 GitBook 中添加内联HTML,以下代码可以添加一个按钮,以允许您查看或隐藏其他部分。 简单来说,就是在【使用1】的内容部分添加一个按钮:

<button class="section" target="section1" show="显示下一部分" hide="隐藏下一部分"></button>

标签说明:

标签 说明
class 该按钮必须属于类“section”。//这里就是用到 1部分的section
target 当按下时,将切换id为target的部分。
show 隐藏目标部分时按钮上的文本。
hide 目标部分可见时按钮上的文本。

markdown中示例代码:

<button class="section" target="section2" show="显示模块2" hide="隐藏模块2"></button>
<!--sec data-title="模块2" data-id="section2" data-show=true ces-->
内容部分2
<!--endsec-->

4.4 混合使用

将第2节的button块添加到第1节的内容部分 markdown中示例代码:

<!--sec data-title="标题1" data-id="section0" data-show=true ces-->
内容部分1;
<button class="section" target="section1" show="显示下一部分" hide="隐藏下一部分"></button>
<!--endsec-->
<!--sec data-title="标题2" data-id="section1" data-show=true ces-->
内容部分2
<!--endsec-->

效果图3:

1832b220aa754cd18c504acc7686a560.png

相关文章
|
存储 JSON JavaScript
【2023-08-20】最新PDF.js PDF批注注释插件库:创建、保存和管理PDF注释批注(高亮、文本框、绘图、截屏、历史记录、橡皮檫)-pdf.js
探索基于pdf.js-dist开发的纯Javascript PDF批注插件库,支持保存、导出、导入和管理PDF文件中的批注。多个功能模块为您提供丰富的PDF注释体验。
570 0
【2023-08-20】最新PDF.js PDF批注注释插件库:创建、保存和管理PDF注释批注(高亮、文本框、绘图、截屏、历史记录、橡皮檫)-pdf.js
|
9天前
|
IDE Java 开发工具
在 Vim 里为 Markdown 文档展示导航窗格
在一个很长的 Markdown 文档里要准确跳转到某标题并不容易,如果像 Word 那样有个导航窗格就好了。
23 6
文本,vitepress两栏怎样设置,应用场景是每个导航都是单独的markdown文件
文本,vitepress两栏怎样设置,应用场景是每个导航都是单独的markdown文件
文本,vitepress代码风格配置和序号配置,第几行到第几行出现高亮显示,最上方图标出现 ,网页排序出现博客,vitepress如何默认折叠效果
文本,vitepress代码风格配置和序号配置,第几行到第几行出现高亮显示,最上方图标出现 ,网页排序出现博客,vitepress如何默认折叠效果
文本,vitepress的使用,vitepress的参考文档,自定义主页,从创建package之后的资料,底部命令的创建
文本,vitepress的使用,vitepress的参考文档,自定义主页,从创建package之后的资料,底部命令的创建
|
6月前
|
JSON 前端开发 JavaScript
【2024-04-22 源码】最新PDF批注注释插件库,pdf.js插件库,纯前端离线JavaScript库(PDF高亮、下划线、橡皮擦、文本框、画笔、历史记录)
一款基于 pdf.js 开发的PDF批注插件库,支持纯离线内网部署,功能完善、强大且在不断升级,极易上手,欢迎关注!
192 4
【2024-04-22 源码】最新PDF批注注释插件库,pdf.js插件库,纯前端离线JavaScript库(PDF高亮、下划线、橡皮擦、文本框、画笔、历史记录)
|
JavaScript 前端开发 Windows
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
VScode的注释和标题,标签,img的src属性(如何网页上插入图片)(Mac如何开启js控制台)(如何免费复制网页中的文字)
uniapp 文本复制及文件预览
uniapp 文本复制及文件预览
165 0
tinymce 设置和获取编辑器的内容
tinymce 设置和获取编辑器的内容
103 0
SVG VSCode 插件(语法提示补全、预览插件)
SVG VSCode 插件(语法提示补全、预览插件)
1347 0