🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

github.com/imyelo/docsify-pagination

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

github.com/imyelo/docsify-pagination

v2.10.1+incompatible
Source
Go
Version published
Created
Source

docsify-pagination

Pagination for docsify

npm license PRs Welcome

How does it look like?

screenshot

Install

  • insert script into document
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
  • specify the label text (optional)
window.$docsify = {
  // ...
  pagination: {
    previousText: '上一章节',
    // or
    nextText: {
      '/en/': 'NEXT',
      '/': '下一章节'
    }
    crossChapter: true,
    crossChapterText: true,
  },
}

Options

pagination.previousText

  • Default: 'PREVIOUS'
  • Type: String | Object
  • Description: The text of previous label.

pagination.nextText

  • Default: 'NEXT'
  • Type: String | Object
  • Description: The text of next label.

pagination.crossChapter

  • Default: false
  • Type: Boolean
  • Description: Allow navigation to previous/next chapter.

pagination.crossChapterText

  • Default: false
  • Type: Boolean
  • Description: Display chapter name.

pagination.routerMode

  • Deprecated
  • Default: window.$docsify.routerMode
  • Type: String
  • Description: Router mode. In most cases, you don't need to modify it. Docsify-Pagination will take care of it for you.

Example

Run example on local

How to open these?

$ git clone https://github.com/imyelo/docsify-pagination.git && cd docsify-pagination && yarn
$ yarn example

Online Showcase

License

MIT © yelo

FAQs

Package last updated on 28 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts