readme.md

docsify-pagination

Pagination for docsify

How does it look like?

Install

1. insert script into document

<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>

2. 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

• Example
• Example with Docsify's History Route-Mode
• Example with Localization

How to open these?

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

Online Showcase

• Tina.js
• 😘 Tell us yours ...

Related

• docsify

License

MIT © yelo