如何在 Spring RestDoc (asciidoc) 中折叠 TOC目录?

如何解决如何在 Spring RestDoc (asciidoc) 中折叠 TOC目录?

我使用过 SpringRestDoc 并且想要折叠目录。

在我的index.adoc下方

= Service Rest Docs API Document
:doctype: book
:icons: font
:source-Highlighter: highlightjs
:toc2: left
:theme: flatly
:toclevels: 1
:sectlinks:

[[introduction]]

== information

----
Spring Rest Document
----

...

谢谢,

解决方法

Asciidoctor 的默认模板不包括展开/折叠 ToC 的功能。您需要添加自己的 CSS/JavaScript 才能实现该目标。

最简单的方法是使用“docinfo”文件。有关详细信息,请参阅 https://docs.asciidoctor.org/asciidoctor/latest/docinfo/

这是一个非常简单的实现来演示这个概念:

  1. 在您的文档的标题中(例如,就在 :doctype: 属性定义下方),添加行 :docinfo: shared

  2. 在与您的文档相同的文件夹中创建一个名为“docinfo.html”的文件;此文件包含您的自定义 CSS 和 JavaScript。

  3. 将以下内容添加到 docinfo.html 文件:

    <style>
    button.tocSwitch {
      position: absolute;
      top: 0;
      left: 0;
    }
    </style>
    
    <script>
    document.addEventListener('DOMContentLoaded',function () {
      var target = document.querySelector('#header')
      var button = document.createElement('button')
      button.className = 'tocSwitch'
      button.innerHTML = 'ToC'
      button.addEventListener('click',function (e) {
        e.stopPropagation()
        var toc = document.querySelector('#toc')
        var body = document.querySelector('body')
        if (body.classList.contains('toc2')) {
          body.classList.remove('toc2')
          body.classList.remove('toc-left')
          toc.style.display = 'none'
        }
        else {
          body.classList.add('toc2')
          body.classList.add('toc-left')
          toc.style.display = 'block'
        }
      })
      target.appendChild(button)
    })
    </script>
    

此内容为按钮定义了一些 CSS 样式,以及一些动态创建按钮的 JavaScript,将按钮添加到页面的标题,以及一个事件侦听器,以便当您单击按钮时,适当的类名和 CSS进行样式调整以显示/隐藏 ToC。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


Selenium Web驱动程序和Java。元素在(x,y)点处不可单击。其他元素将获得点击?
Python-如何使用点“。” 访问字典成员?
Java 字符串是不可变的。到底是什么意思?
Java中的“ final”关键字如何工作?(我仍然可以修改对象。)
“loop:”在Java代码中。这是什么,为什么要编译?
java.lang.ClassNotFoundException:sun.jdbc.odbc.JdbcOdbcDriver发生异常。为什么?
这是用Java进行XML解析的最佳库。
Java的PriorityQueue的内置迭代器不会以任何特定顺序遍历数据结构。为什么?
如何在Java中聆听按键时移动图像。
Java“Program to an interface”。这是什么意思?
Java在半透明框架/面板/组件上重新绘画。
Java“ Class.forName()”和“ Class.forName()。newInstance()”之间有什么区别?
在此环境中不提供编译器。也许是在JRE而不是JDK上运行?
Java用相同的方法在一个类中实现两个接口。哪种接口方法被覆盖?
Java 什么是Runtime.getRuntime()。totalMemory()和freeMemory()?
java.library.path中的java.lang.UnsatisfiedLinkError否*****。dll
JavaFX“位置是必需的。” 即使在同一包装中
Java 导入两个具有相同名称的类。怎么处理?
Java 是否应该在HttpServletResponse.getOutputStream()/。getWriter()上调用.close()?
Java RegEx元字符(。)和普通点?