docsify-sidebar-plus

docsify-sidebar-plus

中文文档

Introduction

docsify-sidebar-plus is a plugin designed to enhance the left sidebar of docsify. It offers additional customization options and features, making document navigation more flexible and powerful.

Features

• Multi-level Menu Support: Supports nested multi-level menus.
• Customizable Styles: Allows customization of menu appearance through CSS.
• Dynamic Loading: Supports asynchronous loading of menu content.
• Invalid Link Configuration: Configurable prompt titles and styles for invalid links.
• Search Integration: Seamlessly integrates with docsify's search plugin.
• Responsive Design: Adapts to devices with different screen sizes.

Usage

  <!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>

<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-plus@1.2.2/collapsible-sidebar.min.js"></script>

  <!-- Other scripts -->

Directory Format

* example
  * [README](/)
  * [markdown](/markdown)
  * [Debug](/Debug)
  * [invaild-link](/invaild-link)
* more
  * [docsify](https://docsify.js.org/)

Or format like bellow

- example
  - [README](/)
  - [markdown](/markdown)
  - [Debug](/Debug)
  - [invaild-link](/invaild-link)
- more
  - [docsify](https://docsify.js.org/)

preview

Configuration

window.$docsify = {

    // Other configurations

      sidebarPlus: {  // Plugin configuration
        expireMinutes: 60, // Duration for remembering sidebar scroll position (minutes), default 60 minutes
        invalidLinkTitle: 'invaild link', // Invalid link prompt title, default 'invaild link'
        invalidLinkStyle: 'alert',  // Invalid link prompt style, default 'alert', options: show/alert/hide
        linkCheckCacheTime: 10,   // Asynchronous link availability check cache time (minutes), default 10 minutes
      }

  // Other configurations

}

Contribution

Feel free to submit Issues or Pull Requests to improve this plugin.