Skip to content

Please update the documentation on how the sidebar / pagination work. #1083

Closed
@joetidee

Description

@joetidee

Currently, there seems to to be very little instruction on how/why certain combinations of _sidebar.md files and folder structures make the sidebar navigation and pagination work.

For example, if my _sidebar.md file contains this:

- **Services**
    - [Getting Started](services/getting-started.md)
    - [Running Service Locally](services/running-services.md)

and my folder structure is this:

/services
  _sidebar.md
  index.md
  getting-started.md
  running-services.md

the pagination and menu structure works fine. But there is no explanation to why this works. If I move .md files into sub-folders, pagination doesn't work. If I simply have...

- [**Services**](services/index.md)

then pagination does not appear and the sidebar no longer shows the sub-pages. It is quite difficult to know where to place files and what to put into the sidebar to try and get a solution whereby the sidebar can auto-generate itself correctly and the pagination work as expected.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsrelated to the documentation of docsify itselfpr welcome

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions